dokkaDocs/com.ciscowebex.androidsdk.phone/MediaOption

MediaOption

class MediaOption

A data type represents the media options of a call.

Since

0.1

Types

Companion

object Companion : BaseLogger

CompositedVideoLayout

enum CompositedVideoLayout : Enum<MediaOption.CompositedVideoLayout>

The video layout for the active speaker and other attendees in the group video meeting. The layout only affects when Phone.VideoStreamMode is Phone.VideoStreamMode.COMPOSITED

Functions

getCaptchaCode

fun getCaptchaCode(): String

Captcha verification code to be entered by user

getCaptchaId

fun getCaptchaId(): String

Unique id for the captcha

getCompanionMode

fun getCompanionMode(): CompanionMode

Returns the Companion mode for the meeting

getCompositedVideoLayout

fun getCompositedVideoLayout(): MediaOption.CompositedVideoLayout?

Returns the video layout of the active speaker and other attendees for the group video call.

getLocalView

fun getLocalView(): View?

getPin

fun getPin(): String

If join as moderator, PIN should be a host key, else PIN should be a meeting password.

getRemoteView

fun getRemoteView(): View?

getSharingView

fun getSharingView(): View?

hasSharing

fun hasSharing(): Boolean

Whether content sharing is enabled.

hasVideo

fun hasVideo(): Boolean

Whether video is enabled.

isModerator

fun isModerator(): Boolean

If true, join the meeting as a moderator.

setCaptchaCode

fun setCaptchaCode(captchaCode: String)

Captcha verification code to be entered by user

setCaptchaId

fun setCaptchaId(captchaId: String)

Unique id for the captcha

setCompanionMode

fun setCompanionMode(companionMode: CompanionMode)

Sets the Companion mode for the meeting

setCompositedVideoLayout

fun setCompositedVideoLayout(compositedLayout: MediaOption.CompositedVideoLayout)

Set the video layout of the active speaker and other attendees for the group video call.

setModerator

fun setModerator(moderator: Boolean)

If true, join the meeting as a moderator.

setPin

fun setPin(pin: String)

If join as moderator, PIN should be a host key, else PIN should be a meeting password.