2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

ConferenceJoinOptions.Builder

The ConferenceJoinOptions.Builder model is responsible for building conferences. It creates a new builder and the ConferenceJoinOptions instance. It also sets parameters and types of participants.

Available in the package com.voxeet.sdk.services.builders.ConferenceJoinOptions.Builder.

Constructors

Builder

Builder(@NonNull conference: Conference)

Creates a new builder.

Parameters

NameTypeDescription
conferenceConferencenon null valid conference.

Methods

setParamsHolder

setParamsHolder(@Nullable paramsHolder: ParamsHolder): ConferenceJoinOptions.Builder

Adds parameters into the conference.

Parameters

NameTypeDescription
paramsHolderParamsHoldernullable reference to parameters.

Returns: ConferenceJoinOptions.Builder - the builder instance.

setConferenceParticipantType

setConferenceParticipantType(@NonNull conferenceParticipantType: ConferenceParticipantType): ConferenceJoinOptions.Builder

Sets the type of the joining participant, from a local point of view. There are the following participant types: normal (by default), broadcaster (for streaming and broadcasting modes), or listener (only for receiving information).

Parameters

NameTypeDescription
conferenceParticipantTypeConferenceParticipantTypenon null specified type of the conference participant

Returns: ConferenceJoinOptions.Builder - the builder instance.

build

build(): ConferenceJoinOptions

Constructs the corresponding ConferenceJoinOptions from the data set.

Returns: @NonNull ConferenceJoinOptions - a new valid instance of the conference join representation.