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() -> 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) -> 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) -> 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) -> MediaOption

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

    Since

    1.4.0

    Declaration

    Swift

    @available(iOS 11.2, *)
public static func audioVideoScreenShare(video: (local: MediaRenderView, remote: MediaRenderView)? = nil, screenShare: MediaRenderView? = nil, applicationGroupIdentifier: String) -> MediaOption

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

    Note

    layout is deprecated. Use compositedVideoLayout instead, they do the same thing, just changed the naming

    Since

    2.5.0

    Declaration

    Swift

    @available(*, deprecated)
public var layout: CompositedVideoLayout?

  • 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?

  • 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?

  • A local unique identifier of a media options.

    Since

    1.2.0

    Declaration

    Swift

    var uuid: UUID? { get set }