sdk-api/com.pexip.sdk.api.infinity/InfinityService/ConferenceStep

ConferenceStep

interface ConferenceStep

Represents the Conference control functions section.

Properties

conferenceAlias

open val conferenceAlias: String

A conference alias that this conference step will use.

open val ~~requestBuilder~~: InfinityService.RequestBuilder

The request builder that produced this conference step.

Functions

availableLayouts

open fun availableLayouts(token: Token): Call<Set<LayoutId>>

This returns a list of all available layouts for the given conference.

open fun breakout(breakoutId: BreakoutId): InfinityService.BreakoutStep

Sets the breakout ID.

open fun clearAllBuzz(token: Token): Call<Boolean>

Lowers all raised hands.

open fun conference(conferenceAlias: String): InfinityService.ConferenceStep

Sets the conference alias.

open fun disconnect(token: Token): Call<Boolean>

Disconnects all conference participants, including the participant calling the function.

open fun events(token: Token): EventSourceFactory

Subscribes to server-side events.

open fun layoutSvgs(token: Token): Call<Map<LayoutId, String>>

This provides all SVG representations of the layouts that are active on the given conference.

open fun lock(token: Token): Call<Boolean>

Locks the conference.

open fun message(request: MessageRequest, token: Token): Call<Boolean>

Sends a message to all participants in the conference.

open fun muteGuests(token: Token): Call<Boolean>

Mutes all guests in a conference.

open fun participant(participantId: ParticipantId): InfinityService.ParticipantStep

Sets the participant ID.

open fun refreshToken(token: Token): Call<RefreshTokenResponse>

Refreshes the token.

open fun releaseToken(token: Token): Call<Boolean>

Releases the token.

open fun requestToken(request: RequestTokenRequest): Call<RequestTokenResponse>

open fun requestToken(request: RequestTokenRequest, pin: String): Call<RequestTokenResponse>

Requests a token for the conference alias.

setGuestsCanUnmute

open fun setGuestsCanUnmute(request: SetGuestCanUnmuteRequest, token: Token): Call<Boolean>

Configure whether or not guests can unmute themselves when they have been muted by a host (either directly muted or via muteGuests).

open fun theme(token: Token): Call<Map<String, SplashScreenResponse>>

Provides the theme resources of the conference (direct media only). Used in conjunction with the splash_screen server event, the relevant theme resources can be used to locally render a particular splash screen on the client.

open fun theme(path: String, token: Token): String

Creates a URL that points to a specific theme resource, such as an image.

transformLayout

open fun transformLayout(request: TransformLayoutRequest, token: Token): Call<Boolean>

This request changes the conference layout, controls streaming content, and enables/disables indicators and overlay text.

open fun unlock(token: Token): Call<Boolean>

Unlocks the conference.

open fun unmuteGuests(token: Token): Call<Boolean>

Unmutes all guests in a conference.