PlanetKitConferenceDelegate Protocol Reference


                    
                    
                    didConnect(_:connected:)

Called when the conference room is connected.

Declaration

Swift

func didConnect(_ conference: PlanetKitConference, connected: PlanetKitConferenceConnectedParam)

Parameters

`conference`	The conference object.
`connected`	An additional parameter delivered when the conference is connected.


                    
                    
                    didDisconnect(_:disconnected:)

Called when the conference room is disconnected.

Declaration

Swift

func didDisconnect(_ conference: PlanetKitConference, disconnected: PlanetKitDisconnectedParam)

Parameters

`conference`	The conference object.
`disconnected`	An additional parameter delivered when the conference is disconnected. `PlanetKitDisconnectedParam.userCode` has a valid release code if `PlanetKitDisconnectedParam.reason` is `.userError`.


                    
                    
                    peerListDidUpdate(_:updated:)

Called if the peer list of the conference has changes in state.

Declaration

Swift

func peerListDidUpdate(_ conference: PlanetKitConference, updated: PlanetKitConferencePeerListUpdateParam)

Parameters

`conference`	The conference object.
`updated`	An additional parameter delivered when the peer list is updated.


                    
                    
                    peersVideoDidUpdate(_:updated:)

Called if the peer’s video of the conference has changes in state.

Declaration

Swift

func peersVideoDidUpdate(_ conference: PlanetKitConference, updated: PlanetKitConferenceVideoUpdateParam)

Parameters

`conference`	The conference object.
`updated`	An additional parameter delivered when the peer’s video is updated.


                    
                    
                    didReceiveAppControlMessage(_:message:)

Called when a control message is received from the app server.

Declaration

Swift

@objc
optional func didReceiveAppControlMessage(_ conference: PlanetKitConference, message: Data)

Parameters

`conference`	The conference object.
`message`	The message data.

didDetectMyVideoNoSource(_:)
Called when the user’s video has no source detected.
Declaration
Swift

@objc optional func didDetectMyVideoNoSource(_ conference: PlanetKitConference)

Short Data


                    
                    
                    didReceiveShortData(_:senderId:dataType:data:)

Called when the short data is received.

Declaration

Swift

@objc
optional func didReceiveShortData(_ conference: PlanetKitConference, senderId: PlanetKitUserId, dataType: String, data: Data)

Parameters

`conference`	The conference object.
`senderId`	The sender’s user ID.
`dataType`	The type of the short data.
`data`	The short data.

Mute


                    
                    
                    peersMicDidMute(_:peers:)

Called when the peers’s microphone is muted.

Declaration

Swift

@objc
optional func peersMicDidMute(_ conference: PlanetKitConference, peers: [PlanetKitConferencePeer])

Parameters

`conference`	The conference object.
`peers`	An array of `PlanetKitConferencePeer` objects representing the peers.


                    
                    
                    peersMicDidUnmute(_:peers:)

Called when the peers’s microphone is unmuted.

Declaration

Swift

@objc
optional func peersMicDidUnmute(_ conference: PlanetKitConference, peers: [PlanetKitConferencePeer])

Parameters

`conference`	The conference object.
`peers`	An array of `PlanetKitConferencePeer` objects representing the peers.


                    
                    
                    myMuteRequestedByPeer(_:peer:mute:)

Called when the peer requests to mute or unmute the local user’s microphone.

Declaration

Swift

@objc
optional func myMuteRequestedByPeer(_ conference: PlanetKitConference, peer: PlanetKitConferencePeer, mute: Bool)

Parameters

`conference`	The conference object.
`peer`	The peer user who requested the mute or unmute.
`mute`	`true` if the peer requests to mute the local user’s microphone, otherwise `false`.

Hold/Unhold


                    
                    
                    peersDidHold(_:peerHolds:)

Called when the peers hold the conference.

Declaration

Swift

@objc
optional func peersDidHold(_ conference: PlanetKitConference, peerHolds: [PlanetKitConferencePeerHold])

Parameters

`conference`	The conference object.
`peerHolds`	The list of peers who hold the conference.


                    
                    
                    peersDidUnhold(_:peers:)

Called when the peers unhold the conference.

Declaration

Swift

@objc
optional func peersDidUnhold(_ conference: PlanetKitConference, peers: [PlanetKitConferencePeer])

Parameters

`conference`	The conference object.
`peers`	The list of peers who unhold the conference.

Screen Share


                    
                    
                    screenShareDidUpdate(_:updated:)

Called when the screen share status of the peer user is updated.

Declaration

Swift

@objc
optional func screenShareDidUpdate(_ conference: PlanetKitConference, updated: PlanetKitConferenceScreenShareUpdateParam)

Parameters

`conference`	The conference object.
`updated`	The `PlanetKitConferenceScreenShareUpdateParam` object containing the updated screen share information.

myScreenShareDidStopByHold(_:)
Called when the screen share has stopped due to a hold action.
Declaration
Swift

@objc optional func myScreenShareDidStopByHold(_ conference: PlanetKitConference)

Data Session


                    
                    
                    dataSessionIncoming(_:streamId:subgroup:type:)

Called when the data session is incoming.

Declaration

Swift

@objc
optional func dataSessionIncoming(_ conference: PlanetKitConference, streamId: PlanetKitDataSessionStreamId, subgroup: PlanetKitSubgroup?, type: PlanetKitDataSessionType)

Parameters

`conference`	The conference object.
`streamId`	The stream ID of the data session.
`subgroup`	The subgroup of the data session.
`type`	The type of the data session.

Screen Share - Broadcast

didStartMyBroadcast(_:)

Called when the ReplayKit session starts for screen share.
didFinishMyBroadcast(_:)

Called when the ReplayKit session stops for screen share.
didErrorMyBroadcast(_:error:)

Called when an error occurs on the ReplayKit session.

Shared Contents


                    
                    
                    peersDidSetSharedContents(_:sharedContents:)

Called when the shared contents are set by peers in the conference.

Declaration

Swift

@objc
optional func peersDidSetSharedContents(_ conference: PlanetKitConference, sharedContents: [PlanetKitConferenceSetSharedContent])

Parameters

`conference`	The conference object.
`sharedContents`	An array of `PlanetKitConferenceSetSharedContent` objects representing the shared contents.


                    
                    
                    peersDidUnsetSharedContents(_:peers:)

Called when the shared contents are unset by peers in the conference.

Declaration

Swift

@objc
optional func peersDidUnsetSharedContents(_ conference: PlanetKitConference, peers: [PlanetKitConferencePeer])

Parameters

`conference`	The conference object.
`peers`	An array of `PlanetKitConferencePeer` objects representing the peers.


                    
                    
                    peerDidSetExclusivelySharedContents(_:peer:data:elapsed:)

Called when exclusively shared contents are set by a peer in the conference.

Declaration

Swift

@objc
optional func peerDidSetExclusivelySharedContents(_ conference: PlanetKitConference, peer: PlanetKitConferencePeer, data: Data, elapsed seconds: TimeInterval)

Parameters

`conference`	The conference object.
`peer`	The peer user who set the exclusively shared contents.
`data`	The data representing the exclusively shared contents.
`seconds`	The elapsed time in seconds since the exclusively shared contents were set.


                    
                    
                    peerDidUnsetExclusivelySharedContents(_:peer:)

Called when exclusively shared contents are unset by a peer in the conference.

Declaration

Swift

@objc
optional func peerDidUnsetExclusivelySharedContents(_ conference: PlanetKitConference, peer: PlanetKitConferencePeer)

Parameters

`conference`	The conference object.
`peer`	The peer user who unset the exclusively shared contents.


                    
                    
                    peerDidSetRoomSharedContents(_:peerId:data:elapsed:)

Called when room shared contents are set by a peer in the conference.

Declaration

Swift

@objc
optional func peerDidSetRoomSharedContents(_ conference: PlanetKitConference, peerId: PlanetKitUserId, data: Data, elapsed seconds: TimeInterval)


                    
                    
                    peerDidUnsetRoomSharedContents(_:peerId:)

Called when room shared contents are unset by a peer in the conference.

Declaration

Swift

@objc
optional func peerDidUnsetRoomSharedContents(_ conference: PlanetKitConference, peerId: PlanetKitUserId)

Parameters

`conference`	The conference object.
`peerId`	The ID of the peer who unset the room shared contents.

Subgroup


                    
                    
                    peersDidUpdatePublicSubgroup(_:updated:)

Called when the public subgroup of the conference has changes in state.

Declaration

Swift

@objc
optional func peersDidUpdatePublicSubgroup(_ conference: PlanetKitConference, updated: PlanetKitConferenceSubgroupUpdateParam)

Network Status


                    
                    
                    networkDidUnavailable(_:willDisconnected:)

Called when the network is unavailable.

Declaration

Swift

@objc
optional func networkDidUnavailable(_ conference: PlanetKitConference, willDisconnected seconds: TimeInterval)

Parameters

`conference`	The conference object.
`willDisconnected`	The remaining time until the conference is disconnected.


                    
                    
                    networkDidReavailable(_:)

Called when the network is reavailable.

Declaration

Swift

@objc
optional func networkDidReavailable(_ conference: PlanetKitConference)

Parameters


                                conference

The conference object.

Exception


                    
                    
                    exception(_:exceptions:)

Called when the exception message from the server occurs in a conference.

Declaration

Swift

@objc
optional func exception(_ conference: PlanetKitConference, exceptions: [PlanetKitConferenceExceptionMessage])

Parameters

`conference`	The conference object.
`exceptions`	An array of `PlanetKitConferenceExceptionMessage` objects representing the exceptions that occurred.