MediaOption

public struct MediaOption

A data type represents the media options of a Call.

Since

1.2.0

  • The video layout for the active speaker and other attendees in the group video meeting.

    Since

    2.5.0
    See more

    Declaration

    Swift

    public enum CompositedVideoLayout

  • Constructs an audio only media option.

    Since

    1.2.0

    Declaration

    Swift

    public static func audioOnly(companionMode: CompanionMode = .None) -> MediaOption

  • Constructs an audio and video media option with video render views.

    Since

    1.2.0

    Declaration

    Swift

    public static func audioVideo(local: MediaRenderView?, remote: MediaRenderView?, companionMode: CompanionMode = .None) -> MediaOption

  • Constructs an audio and video media option with optional render views. The render views can be set after call is connected.

    Since

    1.3.0

    Declaration

    Swift

    public static func audioVideo(renderViews: (local: MediaRenderView, remote: MediaRenderView)? = nil, companionMode: CompanionMode = .None) -> MediaOption

  • Constructs an audio, video, and screen share media option with optional render views. The render views can be set after call is connected.

    Since

    1.3.0

    Declaration

    Swift

    public static func audioVideoScreenShare(video: (local: MediaRenderView?, remote: MediaRenderView?)? = nil, screenShare: MediaRenderView? = nil, companionMode: CompanionMode = .None) -> MediaOption

  • Join the meeting as a moderator.

    Since

    2.6.0

    Declaration

    Swift

    public var moderator: Bool
  • pin

    If join as moderator, PIN should be a host key, else PIN should be a meeting password. In general, The PIN is not required. unless the WebexError.requireHostPinOrMeetingPassword error be received when dial.

    Since

    2.6.0

    Declaration

    Swift

    public var pin: String?

  • Unique id for the captcha

    Since

    3.7.0

    Declaration

    Swift

    public var captchaId: String?

  • Captcha verification code to be entered by user

    Since

    3.7.0

    Declaration

    Swift

    public var captchaVerifyCode: String?

  • The video layout for the active speaker and other attendees in the group video meeting.

    Note

    the layout just affects under composited videoStreamMode.

    Since

    2.8.0

    Declaration

    Swift

    public var compositedVideoLayout: CompositedVideoLayout?

  • Data type that represents whether the meeting has to be moved to this device completely or just has to be joined from this device

    Since

    3.12.0

    Declaration

    Swift

    public var companionMode: CompanionMode