PlanetKitConferencePeer

public class PlanetKitConferencePeer : NSObject

A class representing a peer user in a PlanetKit conference.

  • id

    The ID of the peer user.

    Declaration

    Swift

    @objc
public let id: PlanetKitUserId

  • Indicates whether the data session is supported by the peer user.

    Declaration

    Swift

    @objc
public var isDataSessionSupported: Bool { get }

    Return Value

    true if the data session is supported, false otherwise.

  • Gets the current mute status.

    Declaration

    Swift

    @objc
public var isMuted: Bool { get }

  • Gets the current hold status.

    Declaration

    Swift

    @objc
public var holdStatus: PlanetKitHoldStatus { get }

  • Gets all the names of the currently subscribed subgroups.

    Declaration

    Swift

    @objc
public var subgroupNames: [String]? { get }

  • Gets the current subgroup name of video from the subgroup video event.

    Declaration

    Swift

    @objc
public var currentVideoSubgroupName: String? { get }

  • Gets the current subgroup name of screen share from the screen share event.

    Declaration

    Swift

    @objc
public var currentScreenShareSubgroupName: String? { get }

  • Gets the current shared contents.

    Declaration

    Swift

    @objc
public var sharedContents: PlanetKitSharedContents? { get }

  • The type of user equipment of the peer user.

    Declaration

    Swift

    @objc
public internal(set) var userEquipmentType: PlanetKitUserEquipmentType { get }

  • The display name of the peer user.

    Declaration

    Swift

    @objc
public internal(set) var displayName: String? { get }

  • The local IP address for SIP communication.

    Declaration

    Swift

    @objc
public internal(set) var sipLocalIP: String? { get }

  • The device information for SIP communication.

    Declaration

    Swift

    @objc
public internal(set) var sipDeviceInfo: String? { get }

Subgroup Status

  • Gets the current peer’s video status.

    Remark

    The error code thrown is defined at PlanetKitNSErrorCode.

    Declaration

    Swift

    @objc
public func videoStatus(subgroupName: String?) throws -> PlanetKitVideoStatus

  • Checks if this peer is sending screen share.

    Remark

    The error code thrown is defined at PlanetKitNSErrorCode.

    Declaration

    Swift

    @objc
public func screenShareStatus(subgroupName: String?) throws -> PlanetKitScreenShareStatus

  • Gets the peer’s audio volume setting.

    Throws

    An error of type NSError with the domain “ConferencePeer” and the error code defined at PlanetKitNSErrorCode.

    Remark

    The volume setting range is in percentage from 0 to 110. The value 0 is muted, 100 is the original volume, and 110 amplifies the original volume to +9dB.

    Declaration

    Swift

    @objc
public func volumeLevelSetting(subgroupName: String?) throws -> PlanetKitVolumeLevel

    Parameters

    subgroupName

    The name of the subgroup to get the volume level setting for.

    Return Value

    The volume level setting for the specified subgroup.