Documentation

Class: ConversationCall

ConversationCall

Represents a call within the context of a conversation/conference.

new ConversationCall()

Extends

Methods

changeStreamPriority(priority)

Changes the priority of the stream represented by this one.

Parameters:
Name Type Description
priority number
Returns:
Type
Promise

getCallId()

Returns the call id of the call represented by this one.

Returns:

Call id.

Type
string

getConversation()

Returns the conversation

Returns:
Type
Conversation

getRecordingInfo()

Returns the recoding information, if any.

Returns:
Type
RecordingInfo | null

getStream()

Returns the stream at play in the call represented by this one.

Returns:

A stream.

Type
Stream

getStreamingInfo()

Returns the streaming information, if any.

Returns:
Type
StreamingInfo | null

isRecorded()

Tests whether the call represented by this one is recorded.

Returns:
Type
boolean

isStreamed()

Tests whether the call represented by this one is streamed.

Returns:
Type
boolean

on(listener)

Adds a listener to a Observable event

Parameters:
Name Type Description
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

removeListener(eventType, listener)

Remove existing listener to Observable event

Parameters:
Name Type Description
eventType String
listener function
Inherited From:
Overrides:
Returns:

this instance for chaining

Type
Observable

replacePublishedStream(newStream, callbacks)

Replaces the currently published stream by a given one.
If the first parameter is null then the second parameter must provides a property named
getStream. The getStream property shall be a function returning a Promise of a Stream.

Parameters:
Name Type Description
newStream Stream

A new stream.
callbacks object

Callbacks.

Properties
Name Type Description
getStream function

A function returning a promise of a stream.
Returns:

The newly assigned stream.

Type
Promise.<Stream>

startRecordingPublishedStream(options)

Starts recording the currently published stream.

Parameters:
Name Type Description
options Object

Recording preferences.

Properties
Name Type Description
audioOnly boolean

Whether to record only audio.
videoOnly boolean

Whether to record only video.
customIdInFilename string

This string will be added to the name of the final file.
data object

User data.
ttl number

The time to live (in seconds) of the recording after being successfully created. By default, the data is persistent.
Returns:
Type
Promise.<RecordingInfo>

startStreaming(options)

Starts streaming.

Parameters:
Name Type Description
options StreamingOptions
Returns:
Type
Promise.<StreamingInfo>

stopRecordingPublishedStream()

Stops recording.

Returns:
Type
Promise.<RecordingInfo>

stopStreaming()

Stops streaming.

Returns:
Type
Promise.<StreamingInfo>