MediaStream

public class MediaStream

A MediaStream instance represents an auxiliary stream.

Since

3.5.0

  • the MediaStreamType of auxiliary stream

    Since

    3.5.0

    Declaration

    Swift

    public private(set) var streamType: MediaStreamType { get }

  • person represented this auxiliary stream

    Since

    3.5.0

    Declaration

    Swift

    public private(set) var person: CallMembership { get }

  • The view rendering upon this auxiliary stream

    Since

    3.5.0

    Declaration

    Swift

    public var renderView: MediaRenderView? { get set }

  • True if this stream is already pinned. Otherwise, false.

    Since

    3.6.0

    Declaration

    Swift

    public private(set) var isPinned: Bool { get }

  • True if this stream is allowed to pin. Otherwise, false

    Since

    3.6.0

    Declaration

    Swift

    public private(set) var canPin: Bool { get }

  • return the video dimensions of this auxiliary stream in pixels

    Since

    3.5.0

    Declaration

    Swift

    public func getSize() -> CGSize

    Return Value

    Size of the auxiliary stream

  • Close this auxiliary stream. Client can manually invoke this API to close stream or SDK will automatically Close the last opened stream if needed.

    Since

    3.5.0

    Declaration

    Swift

    public func close()

  • This will be triggered when an auxiliary stream info is changed

    Since

    3.5.0

    Declaration

    Swift

    public func setOnMediaStreamInfoChanged(listener: @escaping (MediaStreamChangeEventType, MediaStreamChangeEventInfo) -> Void)

    Parameters

    MediaStreamChangeEventType

    The auxiliary stream changed event type.
    MediaStreamChangeEventInfo

    the auxiliary stream change information.

    Return Value

    Void