webrtc

Type Members

1. final case class ApiActiveCall(callId: Long, peer: ApiPeer, callMembers: IndexedSeq[Refs.ApiCallMember]) extends Product with Serializable

   

   Active Calls.

   Active Calls. Used in broadcasting states of current calls.

   callId

   Call Id

   peer

   Call's peer

   callMembers

   Call Members

2. trait ApiAdvertiseMaster extends ApiWebRTCSignaling

   

3. final case class ApiAdvertiseSelf(peerSettings: Option[Refs.ApiPeerSettings]) extends ApiWebRTCSignaling with Product with Serializable

   

   Advertizing self to a master mode

   Advertizing self to a master mode

   peerSettings

   Optional peer Settings

4. final case class ApiAnswer(sessionId: Long, sdp: String) extends ApiWebRTCSignaling with Product with Serializable

   

   Answer signal

   Answer signal

   sessionId

   Session Id of answer

   sdp

   Answer SDP

5. final case class ApiCallMember(userId: Int, state: Refs.ApiCallMemberStateHolder) extends Product with Serializable

   

   Call Member

   Call Member

   userId

   Member User Id

   state

   State of member

6. trait ApiCallMemberState extends Enumeration

   

7. final case class ApiCallMemberStateHolder(state: Refs.ApiCallMemberState, fallbackIsRinging: Option[Boolean], fallbackIsConnected: Option[Boolean], fallbackIsConnecting: Option[Boolean], fallbackIsRingingReached: Option[Boolean], fallbackIsEnded: Option[Boolean]) extends Product with Serializable

   

   Call Member state holder

   Call Member state holder

   state

   State Value

   fallbackIsRinging

   Fallback flag for future compatibility of state

   fallbackIsConnected

   Fallback flag for future compatibility of state

   fallbackIsConnecting

   Fallback flag for future compatibility of state

   fallbackIsRingingReached

   Fallback flag for future compatibility of state

   fallbackIsEnded

   Fallback flag for future compatibility of state

8. final case class ApiCandidate(sessionId: Long, index: Int, id: String, sdp: String) extends ApiWebRTCSignaling with Product with Serializable

   

   Candidate signal

   Candidate signal

   sessionId

   Session Id of candidate

   index

   Index of candidate

   id

   Id of candidate

   sdp

   SDP of candidate

9. final case class ApiCloseSession(device: Long, sessionId: Long) extends ApiWebRTCSignaling with Product with Serializable

   

   Close this session and be ready to

   Close this session and be ready to

   sessionId

   Session Id for renegotiation

10. final case class ApiEnableConnection(device: Long, sessionId: Long) extends ApiWebRTCSignaling with Product with Serializable

    

    Notification about enabling connection to peer

    Notification about enabling connection to peer

    device

    Device Id

11. final case class ApiNeedDisconnect(device: Long) extends ApiWebRTCSignaling with Product with Serializable

    

    Notification about requirement about required disconnection from peer

    Notification about requirement about required disconnection from peer

    device

    Device Id

12. final case class ApiNeedOffer(device: Long, sessionId: Long, peerSettings: Option[Refs.ApiPeerSettings]) extends ApiWebRTCSignaling with Product with Serializable

    

    Notification from master that offer is required

    Notification from master that offer is required

    device

    Destination Device Id

    peerSettings

    Optional peer settings

13. final case class ApiNegotinationSuccessful(device: Long, sessionId: Long) extends ApiWebRTCSignaling with Product with Serializable

    

    Notification about on negotiation is successful

    Notification about on negotiation is successful

    device

    Device Id

    sessionId

    Session Id

14. final case class ApiOffer(sessionId: Long, sdp: String, ownPeerSettings: Option[Refs.ApiPeerSettings]) extends ApiWebRTCSignaling with Product with Serializable

    

    Offer signal

    Offer signal

    sessionId

    Session Id of offer

    sdp

    Offer SDP

    ownPeerSettings

    Optional Own Peer settings

15. final case class ApiOnRenegotiationNeeded(device: Long, sessionId: Long) extends ApiWebRTCSignaling with Product with Serializable

    

    Need renegotiate session.

    Need renegotiate session. For example when streams are changed.

16. final case class ApiPeerSettings(is3DESSupported: Option[Boolean], isMobile: Option[Boolean], canBeAudioRelay: Option[Boolean], canConnect: Option[Boolean]) extends Product with Serializable

    

    Peer Settings

    Peer Settings

    is3DESSupported

    Marking if 3DES supported. Default is false.

    isMobile

    Is Peer a mobile phone. Default is false.

    canBeAudioRelay

    If peer can audio relay. Default is false.

17. sealed trait ApiWebRTCSignaling extends AnyRef

    

18. final case class RequestDoCall(peer: ApiOutPeer, eventBusId: String) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Do Call.

    Do Call. Right after a call client need to start sending CallInProgress

    peer

    destination peer

    eventBusId

    Call Event Bus Id

19. final case class RequestDoCallAgain(callId: Long, user: ApiUserOutPeer) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Call again to user

    Call again to user

    callId

    Call Id

    user

    User to call again

20. final case class RequestGetCallInfo(callId: Long) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Getting Call Information

    Getting Call Information

    callId

    Call Id

21. final case class RequestJoinCall(callId: Long) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Joining Call

    Joining Call

    callId

    Call Id

22. final case class RequestOptimizeSDP(type: String, sdp: String, ownSettings: Refs.ApiPeerSettings, theirSettings: Refs.ApiPeerSettings) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Optimizing SDP

    Optimizing SDP

    type

    Type of SDP (offer or answer)

    sdp

    SDP value

    ownSettings

    Own Settings

    theirSettings

    Their Settings

23. final case class RequestRejectCall(callId: Long) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Rejecting Call

    Rejecting Call

    callId

    Call Id

24. final case class RequestUpgradeCall(callId: Long, peer: ApiGroupOutPeer) extends WebrtcRpcRequest with ContainsHeader with Product with Serializable

    

    Method for upgrading a call from private call to group call

    Method for upgrading a call from private call to group call

    callId

    Call Id

    peer

    Destination peer for upgrading

25. final case class ResponseDoCall(callId: Long) extends RpcResponse with Product with Serializable

    
    callId

    Call Id

26. final case class ResponseGetCallInfo(peer: ApiPeer, groups: IndexedSeq[ApiGroupOutPeer], users: IndexedSeq[ApiUserOutPeer], eventBusId: String) extends RpcResponse with Product with Serializable

    
    peer

    Destination peer

    groups

    Groups

    users

    Users

    eventBusId

    Event Bus Id

27. final case class ResponseOptimizeSDP(optimizedSDP: String) extends RpcResponse with Product with Serializable

    
    optimizedSDP

    Optimized version of SDP

28. final case class UpdateCallHandled(callId: Long) extends Update with Product with Serializable

    

    Update about incoming call handled

    Update about incoming call handled

    callId

    Call Id

29. final case class UpdateCallUpgraded(callId: Long, groupId: Int) extends Update with Product with Serializable

    

    Update about call moved to other peer

    Update about call moved to other peer

    callId

    Call Id

    groupId

    Upgraded group id

30. final case class UpdateIncomingCall(callId: Long) extends Update with Product with Serializable

    

    Update about incoming call (Sent every 10 seconds)

    Update about incoming call (Sent every 10 seconds)

    callId

    Call Id

31. sealed trait WebrtcRpcRequest extends RpcRequest

    

32. trait WebrtcService extends Service