ParamsHolder

The ParamsHolder model allows defining details of a conference.

Available in the package com.voxeet.sdk.json.internal.ParamsHolder.

Methods

setVideoCodec

setVideoCodec(@NonNull videoCodec: String): ParamsHolder

The preferred video codec, 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.

Parameters

NameTypeDescription
videoCodecStringnon null The selected video codec.

Returns: ParamsHolder


setAudioOnly

setAudioOnly(audioOnly: boolean): ParamsHolder

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.

Parameters

NameTypeDescription
audioOnlybooleanA boolean that indicates whether SDK should create an audio-only conference.

Returns: ParamsHolder


setDolbyVoice

setDolbyVoice(activate: boolean): ParamsHolder

Creates a conference enabled with Dolby Voice. For more information about Dolby Voice, see this article. By default, the parameter is set to true.

Parameters

NameTypeDescription
activatebooleanA boolean that specifies whether the application wishes to create a Dolby Voice conference.

Returns: ParamsHolder


setSimulcast

setSimulcast(state: boolean): ParamsHolder

Sets the Simulcast transmission for a specific conference.

Parameters

NameTypeDescription
statebooleanA boolean that indicates whether SDK should enable Simulcast.

Returns: ParamsHolder


setTtl

setTtl(time: int): ParamsHolder

The time to live that allows customizing time after which the SDK terminates empty conferences (is seconds). The default ttl value is 30 seconds.

Parameters

NameTypeDescription
timeintThe time to live (in seconds).

Returns: ParamsHolder


setRtcpMode

setRtcpMode(mode: String): ParamsHolder

The bitrate adaptation mode for video transmission. The parameter triggers a 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.

Parameters

NameTypeDescription
modeStringThe requested rtcpMode, either worst, average (default), or max.

Returns: ParamsHolder


setLiveRecording

setLiveRecording(isEnabled: boolean): ParamsHolder

A boolean that enables and disables live recording. Specify this parameter during the conference creation:

  • Recording audio during Dolby Voice conferences does not require setting the liveRecording parameter. The audio recording is always available in MP3 file and can be downloaded just after the end of a conference. This recording mechanism does not use Mixer.

  • If liveRecording is set to true, and the start method is called, the platform uses Mixer to record a conference. After the conference, the recorded file, in MP3 or MP4 format, is available for download. The recording is also available via the replay method.

  • If liveRecording is set to false, the platform uses a recording mechanism that does not use Mixer. The recorded conference is available only via the replay method.

This parameter does not start the recording; use the start method to turn it on.

Parameters

NameTypeDescription
isEnabledbooleanA boolean that indicates whether liveRecording should be enabled.

Returns: ParamsHolder


setSpatialAudioStyle

setSpatialAudioStyle(@NonNull spatialAudioStyle: SpatialAudioStyle): ParamsHolder

Defines how the spatial location should be communicated between the SDK and the Dolby.io server.

Setting the spatial audio style is supported only on SDK 3.6 and later versions. The earlier SDK versions support only the individual mode and do not allow participants to join conferences created with the spatial audio style set to shared.

Parameters

NameTypeDescription
spatialAudioStyleSpatialAudioStylenon null The spatial audio style.

Returns: ParamsHolder


build

build(): HashMap<String, Object>

Builds a holder in a native HashMap.

Returns: @NonNull HashMap<String, Object>


Did this page help you?