Constructors

Properties

_ice: any[] = []

Conference ice servers

_id: string = ''

Room identifier

_invite: null | Invite = null

Invitation when user doesn't joined the conference.

_left: boolean = false

True if leave method was called

_participants: string[] = []

User identifiers that participate on a conference.

_pendingInvites: {} = {}

Contains a list of pending invitations (still not accepted/rejected by remote peer) transaction identifiers. Used to cancel a previous invitation and determine if an user has been invited.

Type declaration

    _record: boolean = false

    Indicates if conference is being recorded

    _room: any = null

    Janus client

    _server: string = ''

    Conference server

    _session: null | Session = null

    Server client

    _token: string = ''

    Conference access token

    _uninitializingRoom: undefined | Promise<void>
    callTransfer$: Observable<CallTransferEvent>
    callTransferSubject: Subject<CallTransferEvent> = ...
    dependencies: Dependencies = {}
    destroyed$: Observable<void>
    destroyedSubject: Subject<void> = ...
    localStreamAdded$: Observable<StreamEvent>
    localStreamAddedSubject: Subject<StreamEvent> = ...
    localStreamRemoved$: Observable<StreamEvent>
    localStreamRemovedSubject: Subject<StreamEvent> = ...
    mediaManager: MediaManager
    mediaUpdateLock: Lock = ...
    muteChange$: Observable<MuteChangeEvent>
    muteChangeSubject: Subject<MuteChangeEvent> = ...
    muteRequest$: Observable<boolean>
    muteRequestSubject: Subject<boolean> = ...
    parallelSipExtension: null = null
    participant$: Observable<ParticipantEvent>
    participantSubject: Subject<ParticipantEvent> = ...
    remoteStreamAdded$: Observable<StreamEvent>
    remoteStreamAddedSubject: Subject<StreamEvent> = ...
    remoteStreamRemoved$: Observable<StreamEvent>
    remoteStreamRemovedSubject: Subject<StreamEvent> = ...
    sipUri: null = null
    speakerChange$: Observable<SpeakerChangedEvent>
    speakerChangeSubject: Subject<SpeakerChangedEvent> = ...
    subscription: Subscription = ...

    Accessors

    Methods

    • Accept inviting to other participant to make an unattended call transfer

      Parameters

      • callTransferID: string

        identifier of a call transfer

      Returns Promise<void>

    • Removes a participant from this conference.

      Parameters

      • participant: string

        user name to remove.

      Returns Promise<void>

      resolved when remote user leaves conference.

    • Add participant to this conference.

      Parameters

      • participant: string

        user name to add.

      • mediatypes: MediaTypes

        the mediatypes requested to the new participant.

      • Optional requestId: string

        the ID of the request that generated this invitation.

      • Optional context: Record<string, string>

        arbitrary context that can be sent to invites

      Returns Promise<{
          code: number;
          whoAccepted?: string;
      }>

      resolved with a boolean value that indicates if remote accepts the invitation.

      Throws

      if participant is already present on conference or a pending invitation exists.

    • Join this conference and start sending local media defined by mediatype parameter.

      Parameters

      • mediatypes: MediaStreamConstraints

        local media used after joining the conference.

      Returns Promise<void>

    • Leaves this conference or rejects a previous invitation.

      Parameters

      • Optional errorCode: number

        the rejection cause when an invitation is received and the conference has not been joined.

      Returns Promise<Conference>

      resolved on success with self reference.

      Throws

      when already joined or a previous invitation was not received.

    • Create an unattended call transfer towards a user in the system

      Parameters

      • participant: string

        user name to call.

      • mediatypes: MediaTypes

        the mediatypes requested to the new participant.

      Returns Promise<void>

    • Stop local hold Republishes all previously published media, subscribes to previously subscribed media and notifies new status to other participants.

      Returns Promise<void>

    • Update local media types.

      Parameters

      • mediatypes: MediaStreamConstraints | {
            screen: boolean;
        }

        required mediatypes.

      Returns Promise<void>