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

ParticipantStep

interface ParticipantStep

Represents the Participant functions section.

Properties

Link copied to clipboard
open val conferenceStep: InfinityService.ConferenceStep

The conference step that produced this participant step.

Link copied to clipboard
open val participantId: ParticipantId

A participant ID that this participant step will use.

Functions

Link copied to clipboard
open fun buzz(token: Token): Call<Boolean>

Raises a participant's hand.

Link copied to clipboard
open fun call(callId: CallId): InfinityService.CallStep

Sets the call ID.

Link copied to clipboard
open fun calls(request: CallsRequest, token: Token): Call<CallsResponse>

Requests an upgrade of the call to include media.

Link copied to clipboard
open fun clearBuzz(token: Token): Call<Boolean>

Lowers a participant's hand.

Link copied to clipboard
open fun clientMute(token: Token): Call<Unit>

Signals that the participant has muted themselves.

Link copied to clipboard
open fun clientUnmute(token: Token): Call<Unit>

Signals that the participant has unmuted themselves.

Link copied to clipboard
open fun disconnect(token: Token): Call<Boolean>

Disconnects a participant.

Link copied to clipboard
open fun dtmf(request: DtmfRequest, token: Token): Call<Boolean>

Sends DTMF digits to the participant.

Link copied to clipboard
open fun message(request: MessageRequest, token: Token): Call<Boolean>

Sends a message to this participant.

Link copied to clipboard
open fun mute(token: Token): Call<Unit>

Requests to mute participant's audio.

Link copied to clipboard
open fun preferredAspectRatio(request: PreferredAspectRatioRequest, token: Token): Call<Boolean>

Specifies the aspect ratio the participant would like to receive.

Link copied to clipboard
open fun releaseFloor(token: Token): Call<Unit>

Requests to release presentation floor.

Link copied to clipboard
open fun role(request: RoleRequest, token: Token): Call<Boolean>

Changes the role of the participant.

Link copied to clipboard
open fun spotlightOff(token: Token): Call<Boolean>

Disables the "spotlight" on a participant.

Link copied to clipboard
open fun spotlightOn(token: Token): Call<Boolean>

Enables the "spotlight" on a participant.

Link copied to clipboard
open fun takeFloor(token: Token): Call<Unit>

Requests to take presentation floor.

Link copied to clipboard
open fun unlock(token: Token): Call<Boolean>

Lets a specified participant into the conference from the waiting room of a locked conference.

Link copied to clipboard
open fun unmute(token: Token): Call<Unit>

Requests to unmute participant's audio.

Link copied to clipboard
open fun videoMuted(token: Token): Call<Unit>

Requests to mute participant's video.

Link copied to clipboard
open fun videoUnmuted(token: Token): Call<Unit>

Requests to unmute participant's video.