View on GitHub
PlanetKitPeerControlDelegate Protocol Reference
PlanetKitPeerControlDelegate
@objc
public protocol PlanetKitPeerControlDelegateA protocol that defines the events for the peer in a conference.
-
Called when the microphone has been muted.
Declaration
Swift
@objc optional func didMuteMic(_ peerControl: PlanetKitPeerControl)Parameters
peerControlThe
PlanetKitPeerControlinstance. -
Called when the microphone has been unmuted.
Declaration
Swift
@objc optional func didUnmuteMic(_ peerControl: PlanetKitPeerControl)Parameters
peerControlThe
PlanetKitPeerControlinstance. -
Called when the video status has been updated for a specific subgroup.
Declaration
Swift
@objc optional func didUpdateVideo(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup, status: PlanetKitVideoStatus)Parameters
peerControlThe
PlanetKitPeerControlinstance.subgroupThe
PlanetKitSubgroupfor which the video status has been updated.statusThe
PlanetKitVideoStatusindicating the updated video status. -
Called when the screen share status has been updated for a specific subgroup.
Declaration
Swift
@objc optional func didUpdateScreenShare(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup, status: PlanetKitScreenShareStatus)Parameters
peerControlThe
PlanetKitPeerControlinstance.subgroupThe
PlanetKitSubgroupfor which the screen share status has been updated.statusThe
PlanetKitScreenShareStatusindicating the updated screen share status.
-
Called when a subgroup has been subscribed.
Declaration
Swift
@objc optional func didSubscribeSubgroup(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup)Parameters
peerControlThe
PlanetKitPeerControlinstance.subgroupThe
PlanetKitSubgroupthat has been subscribed. -
Called when a subgroup has been unsubscribed.
Declaration
Swift
@objc optional func didUnsubscribeSubgroup(_ peerControl: PlanetKitPeerControl, subgroup: PlanetKitSubgroup)Parameters
peerControlThe
PlanetKitPeerControlinstance.subgroupThe
PlanetKitSubgroupthat has been unsubscribed.
-
Called when the peer has been put on hold.
Declaration
Swift
@objc optional func didHold(_ peerControl: PlanetKitPeerControl, reason: String)Parameters
peerControlThe
PlanetKitPeerControlinstance.reasonThe reason for putting the peer on hold.
-
Called when the peer has been taken off hold.
Declaration
Swift
@objc optional func didUnhold(_ peerControl: PlanetKitPeerControl)Parameters
peerControlThe
PlanetKitPeerControlinstance. -
Called when the peer has been disconnected.
Declaration
Swift
@objc optional func didDisconnect(_ peerControl: PlanetKitPeerControl)Parameters
peerControlThe
PlanetKitPeerControlinstance.
-
Called when shared contents have been set.
Declaration
Swift
@objc optional func didSetSharedContents(_ peerControl: PlanetKitPeerControl, data: Data, elapsedSeconds: TimeInterval)Parameters
peerControlThe
PlanetKitPeerControlinstance.dataThe data representing the shared contents.
elapsedSecondsThe elapsed time in seconds since the shared contents were set.
-
Called when shared contents have been unset.
Declaration
Swift
@objc optional func didUnsetSharedContents(_ peerControl: PlanetKitPeerControl)Parameters
peerControlThe
PlanetKitPeerControlinstance.
-
Called when the audio description has been updated.
Declaration
Swift
@objc optional func didUpdateAudioDescription(_ peerControl: PlanetKitPeerControl, description: PlanetKitPeerAudioDescription)Parameters
peerControlThe
PlanetKitPeerControlinstance.descriptionThe updated
PlanetKitPeerAudioDescription.