2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

ConferenceParameters

The ConferenceParameters model allows the application to:

Constructors

constructor

+ new ConferenceParameters(): ConferenceParameters

Returns: ConferenceParameters

Properties

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.

Default value: 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 conditions
  • average: averages the available bandwidth of all the receivers and adjusts the transmission bitrate to this value
  • max: does not adjust the transmission bitrate to the receiver’s bandwidth

Default value: 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

Preferred video codec for conferences.

Possible values: H264 and VP8

Default value: H264