PlanetKitMyMediaStatus

@objc
public class PlanetKitMyMediaStatus : NSObject

A class representing the local users’s media status of the PlanetKit framework.

  • The video status of the local user.

    Declaration

    Swift

    @objc
public var videoStatus: PlanetKitVideoStatus { get }

  • The screen share state of the local user.

    Declaration

    Swift

    @objc
public var screenShareState: PlanetKitScreenShareState { get }

  • Indicates whether the local user’s audio is muted.

    Declaration

    Swift

    @objc
public var isMyAudioMuted: Bool { get }

  • The name of the audio subgroup.

    This property returns the name of the audio subgroup associated with the local user’s media status. If there is no audio subgroup, it returns nil.

    Declaration

    Swift

    @objc
public var audioSubgroupName: String? { get }

  • The name of the audio tagged subgroup.

    This property returns the name of the audio tagged subgroup associated with the local user’s media status. If there is no audio tagged subgroup, it returns nil.

    Declaration

    Swift

    @objc
public var audioTaggedSubgroupName: String? { get }

  • The name of the video subgroup.

    This property returns the name of the video subgroup associated with the local user’s media status. If there is no video subgroup, it returns nil.

    Declaration

    Swift

    @objc
public var videoSubgroupName: String? { get }

  • The subgroup name for screen share.

    Declaration

    Swift

    @objc
public var screenShareSubgroupName: String? { get }

  • Adds a handler for the PlanetKitMyMediaStatusDelegate.

    Declaration

    Swift

    @objc
public func addHandler(_ delegate: PlanetKitMyMediaStatusDelegate, completion: @escaping (Bool) -> Void)

    Parameters

    delegate

    The delegate object conforming to the PlanetKitMyMediaStatusDelegate protocol.
    completion

    A closure that is called when the handler is added. The closure takes a Boolean parameter indicating whether the handler was added successfully.

  • Removes a handler for the PlanetKitMyMediaStatusDelegate.

    Declaration

    Swift

    @objc
public func removeHandler(_ delegate: PlanetKitMyMediaStatusDelegate, completion: @escaping (Bool) -> Void)

    Parameters

    delegate

    The delegate object conforming to the PlanetKitMyMediaStatusDelegate protocol.
    completion

    A closure that is called when the handler is removed. The closure takes a Boolean parameter indicating whether the handler was removed successfully.