Skip to main content

@auvious/rtc / IConferenceSession

Interface: IConferenceSession

Table of contents​

Properties​

Methods​

Properties​

conference​

• conference: IConference

direction​

• Readonly direction: string

eventHandlers​

• eventHandlers: IConferenceSessionEventHandlers

id​

• id: string

remoteEndpoint​

• Readonly remoteEndpoint: IEndpoint<{ [key: string]: any; }>

Methods​

getConferenceMetadata​

▸ getConferenceMetadata(): ConferenceMetadata

Returns​

ConferenceMetadata

getMetadata​

▸ getMetadata(endpoint): Metadata

Parameters​

NameType
endpointIEndpoint<{ [key: string]: any; }>

Returns​

Metadata

hold​

▸ hold(): Promise<void>

Returns​

Promise<void>

isEstablished​

▸ isEstablished(): boolean

Returns​

boolean

isInProgress​

▸ isInProgress(): boolean

Returns​

boolean

isOnHold​

▸ isOnHold(): boolean

Returns​

boolean

leave​

▸ leave(reason?): void

Parameters​

NameType
reason?string

Returns​

void

on​

▸ on(eventId, handler): any

Parameters​

NameType
eventIdstring
handler(event?: any) => void

Returns​

any

publish​

▸ publish(options): Promise<IPublishedStream>

Parameters​

NameType
optionsIPublishOptions

Returns​

Promise<IPublishedStream>

removeConferenceMetadata​

▸ removeConferenceMetadata(key): Promise<void>

Parameters​

NameType
keystring

Returns​

Promise<void>

setConferenceMetadata​

▸ setConferenceMetadata(key, value): Promise<void>

Parameters​

NameType
keystring
valuestring

Returns​

Promise<void>

terminate​

▸ terminate(reason?): void

Parameters​

NameType
reason?string

Returns​

void

unhold​

▸ unhold(): Promise<void>

Returns​

Promise<void>

unpublish​

▸ unpublish(stream): void

Parameters​

NameType
streamIStream

Returns​

void

updateMetadata​

▸ updateMetadata(metadata): Promise<void>

Parameters​

NameType
metadataMetadata

Returns​

Promise<void>