ConferenceParameters
The ConferenceParameters model allows the application to:
- Create an audio-only conference
- Enable Dolby Voice
- Turn the live recording on and off
- Set the transmission bitrate adaptation mode
- Customize the waiting time before terminating an empty conference
- Change the video codec that is used during conferences
Properties
audioOnly
• Optional
audioOnly: boolean
A boolean that indicates whether the application wishes to create an audio-only conference. Setting this parameter to true results in creating a conference that does not allow participants to enable their videos. If a participant calls the startVideo method in an audio-only conference, the SDK returns ServerError.
dolbyVoice
• Optional
dolbyVoice: boolean
A boolean that indicates whether the application wishes to create a conference with Dolby Voice enabled. For more information about Dolby Voice, see this article. By default, the parameter is set to true
.
liveRecording
• liveRecording: boolean
Turns the live recording on and off. Specify this parameter during the conference creation.
- When set to
true
, the recorded file is available at the end of the call and can be downloaded immediately. - When set to
false
, the remix API must be called after the conference to generate and retrieve the recorded file.
This parameter does not start the recording; use the start method to turn it on.
By default, the value is set to false
.
rtcpMode
• rtcpMode: string
The bitrate adaptation mode for the video transmission. The rtcpMode triggers the server to monitor the receivers’ available bandwidth. Based on the analyzed value, the server informs the video sender to automatically adjust the quality of the transmitted video streams.
The possible values are:
worst
: adjusts the transmission bitrate to the receiver who has the worst network conditionsaverage
: averages the available bandwidth of all the receivers and adjusts the transmission bitrate to this valuemax
: does not adjust the transmission bitrate to the receiver’s bandwidth
By default, the value is set to average
.
ttl
• ttl: number
The time to live that enables customizing the waiting time (in seconds) and terminating empty conferences.
The Voxeet service terminates conferences after the established time if no one has joined the new conference or the last participant has left it. The default value is 0 seconds.
videoCodec
• videoCodec: string
The preferred video codec that is used during conferences, either H264, VP8, or none. By default, the value is set to H264
. Setting this parameter to none
results in creating a conference that does not allow participants to enable their videos.
Updated 6 months ago