PlanetKitConference

public class PlanetKitConference : NSObject

extension PlanetKitConference: PlanetKitDataSessionControllable

extension PlanetKitConference: PlanetKitAudioVolumeDelegate

extension PlanetKitConference: PlanetKitAudioDeviceChangeDelegate

extension PlanetKitConference: PlanetKitCameraDeviceChangeDelegate

extension PlanetKitConference : PlanetKitAudioMicCaptureDelegate

extension PlanetKitConference : PlanetKitAudioSpkPlayDelegate

extension PlanetKitConference: PlanetKitVideoOutputDelegate

extension PlanetKitConference: PlanetKitVideoLimiter

extension PlanetKitConference: PlanetKitSharedContentsControllable

extension PlanetKitConference: PlanetKitStatisticsControllable

extension PlanetKitConference: PlanetKitDebugMonitor

The PlanetKitConference class represents a conference in the PlanetKit framework.


                    
                    
                    state

Gets the state of the conference.

Declaration

Swift

@objc
public internal(set) var state: PlanetKitConferenceState { get set }


                    
                    
                    mediaType

Gets the media type of the conference.

Declaration

Swift

@objc
public internal(set) var mediaType: PlanetKitMediaType { get set }

myUserId
The user ID of the local user.
Declaration
Swift

@objc public let myUserId: PlanetKitUserId!
roomId
The ID of the conference room.
Declaration
Swift

@objc public let roomId: String
roomServiceId
The service ID of the conference room.
Declaration
Swift

@objc public let roomServiceId: String
APIKey
The API key used for authentication.
Declaration
Swift

@objc public let APIKey: String?
accessToken
The access token used for authentication.
Declaration
Swift

@objc public let accessToken: String?
enableStatistics
A flag indicating whether statistics are enabled for the conference.
Declaration
Swift

@objc public let enableStatistics: Bool
uuid
The universally unique identifier (UUID) of the conference.
Declaration
Swift

@objc public let uuid: UUID


                    
                    
                    delegate

The delegate object that will receive conference-related events.

Declaration

Swift

@objc
public internal(set) weak var delegate: PlanetKitConferenceDelegate? { get }


                    
                    
                    myVideoStream

The video stream for the local user’s camera.

Declaration

Swift

@objc
public internal(set) var myVideoStream: PlanetKitVideoStream! { get }


                    
                    
                    myScreenShareStream

The video stream for the local user’s screen share.

Declaration

Swift

@objc
public internal(set) var myScreenShareStream: PlanetKitVideoStream! { get }


                    
                    
                    callKitType

The type of CallKit used in the conference.

Declaration

Swift

@objc
public internal(set) var callKitType: PlanetKitCallKitType { get }

callKitParam

The CallKit parameters for iOS.
screen
The screen controllable object for the conference. This property allows you to control the screen used in the conference.

Remark
It is recommended to change the custom camera using PlanetKitJoinConferenceSettingBuilder.withCustomScreenKey(screen:) rather than directly setting and changing this value.
Declaration
Swift

@objc public var screen: PlanetKitScreenControllable? { get set }
audioManager
The audio manager for the conference.
Declaration
Swift

@objc public let audioManager: PlanetKitAudioManager
sendVoiceProcessor
The send voice processor for the conference.
Declaration
Swift

@objc public let sendVoiceProcessor: PlanetKitSendVoiceProcessor


                    
                    
                    subgroupManager

Gets the subgroup manager.

Declaration

Swift

@objc
public internal(set) var subgroupManager: PlanetKitSubgroupManager! { get }

peersCount
Gets the total count of all connected peers, including the local user.

Remark
If the local user is connected, their count is added.
Declaration
Swift

@objc public var peersCount: Int { get }
peers
Gets the list of all peers.

Remark
This is copied from the internal dictionary using locks. If this function is called frequently, it will affect performance. To find a peer member, it’s better to use getPeerMember(peerId:).
Declaration
Swift

@objc public var peers: [String : PlanetKitConferencePeer] { get }
totalPeersCount
Gets the total count of peers in the room. The count does not include the local user.

Remark
Initially, the peer list on the client-side does not contain the complete peer list. The list is updated gradually as the VoIP server sends the remaining peer list to the client.
Declaration
Swift

@objc public var totalPeersCount: Int { get }


                    
                    
                    myMediaStatus

The media status of the local user.

Declaration

Swift

@objc
public internal(set) var myMediaStatus: PlanetKitMyMediaStatus! { get }

myVideoSendCapability
The video capability for sending video in the conference.
Declaration
Swift

@objc public let myVideoSendCapability: PlanetKitVideoCapability
myVideoRecvPreferredHwCodec
The video capability for receiving video in the conference.
Declaration
Swift

@objc public let myVideoRecvPreferredHwCodec: Bool
spkModifier
Sets a modifier to receive audio data before speaker out. The modifier can modify audio data.
Declaration
Swift

@objc public weak var spkModifier: PlanetKitAudioSpkPlayDelegate? { get set }
spkReceiver
Sets a receiver to receive audio data after speaker out. The receiver cannot modify audio data.
Declaration
Swift

@objc public weak var spkReceiver: PlanetKitAudioSpkPlayDelegate? { get set }
micModifier
Sets a modifier to receive audio data before sending audio to the server. The modifier can modify audio data.
Declaration
Swift

@objc public weak var micModifier: PlanetKitAudioMicCaptureDelegate? { get set }
micReceiver
Sets a receiver to receive audio data after sending audio to the server. The receiver cannot modify audio data.
Declaration
Swift

@objc public weak var micReceiver: PlanetKitAudioMicCaptureDelegate? { get set }
peerAudioDescriptionReceiver
Sets a receiver to receive the updated event of audio description for the peer.

Remark
The update interval can be set by PlanetKitJoinConferenceSettingBuilder.withAudioDescriptionUpdateIntervalKey(interval:) The default update interval is 0.5 seconds.
Declaration
Swift

@objc public weak var peerAudioDescriptionReceiver: PlanetKitPeerAudioDescriptionDelegate? { get set }
myAudioDescriptionReceiver
Sets a receiver to receive the updated event of audio description for the local user’s audio.

Remark
The update interval can be set by PlanetKitJoinConferenceSettingBuilder.withAudioDescriptionUpdateIntervalKey(interval:) The default update interval is 0.5 seconds.
Declaration
Swift

@objc public weak var myAudioDescriptionReceiver: PlanetKitMyAudioDescriptionDelegate? { get set }
myVideoModifier
Sets a modifier to receive the local user’s video data before requesting video transmission. The modifier can modify video data.
Declaration
Swift

@objc public weak var myVideoModifier: PlanetKitVideoModifierDelegate? { get set }
myVideoReceiver
A weak reference to the delegate object that will receive video output from the camera.
Declaration
Swift

@objc public weak var myVideoReceiver: PlanetKitVideoOutputDelegate? { get set }

Data Session

isSupportedDataSession
Checks whether the conference supports data sessions.
Declaration
Swift

public var isSupportedDataSession: Bool { get }


                    
                    
                    makeOutboundDataSession(streamId:type:delegate:completion:)

Makes a new outbound data session for the main room.

Declaration

Swift

public func makeOutboundDataSession(streamId: PlanetKitDataSessionStreamId, type: PlanetKitDataSessionType, delegate: PlanetKitOutboundDataSessionDelegate, completion: @escaping PlanetKitOutboundDataSession.Completion)

Parameters

`streamId`	The predefined ID for the app. The ID must be in the range [100, 999].
`type`	The type of the outbound data session.
`delegate`	The event callback for the outbound data session.
`completion`	If successful, the completion handler returns an outbound data session. Otherwise, the completion handler returns `nil`.


                    
                    
                    makeInboundDataSession(streamId:delegate:completion:)

Makes a new inbound data session for the main room.

Declaration

Swift

public func makeInboundDataSession(streamId: PlanetKitDataSessionStreamId, delegate: PlanetKitInboundDataSessionDelegate, completion: @escaping PlanetKitInboundDataSession.Completion)

Parameters

`streamId`	The predefined ID for the app. The ID must be in the range [100, 999].
`delegate`	The event callback for the inbound data session.
`completion`	If successful, the completion handler returns an inbound data session. Otherwise, the completion handler returns `nil`.

unsupportInboundDataSession(streamId:)
Ignores receiving data for the given stream ID.

Remark
In a conference, when PlanetKitConferenceDelegate.dataSessionIncoming(_:streamId:subgroup:type:) occurs, the user must either call makeInboundDataSession(streamId:delegate:completion:) to receive the incoming data or call this function to ignore receiving the incoming data. To ignore receiving data for the incoming stream ID, call unsupportInboundDataSession(streamId:) in PlanetKitConferenceDelegate.dataSessionIncoming(_:streamId:subgroup:type:).
Declaration
Swift

public func unsupportInboundDataSession(streamId: PlanetKitDataSessionStreamId)


                    
                    
                    getOutboundDataSession(streamId:)

Gets the existing outbound data session with the stream ID.

Declaration

Swift

public func getOutboundDataSession(streamId: PlanetKitDataSessionStreamId) -> PlanetKitOutboundDataSession?


                    
                    
                    getInboundDataSession(streamId:)

Gets the existing inbound data session with the stream ID.

Declaration

Swift

public func getInboundDataSession(streamId: PlanetKitDataSessionStreamId) -> PlanetKitInboundDataSession?

PlanetKitAudioVolumeDelegate

didChangeVolume(_:volume:)
Called when the device volume has changed.

See
PlanetKitAudioVolumeDelegate
Declaration
Swift

public func didChangeVolume(_ type: PlanetKitAudioDeviceType, volume: Float)

PlanetKitAudioDeviceChangeDelegate

didAudioDevicesUpdate(devices:)
Called when the list of audio devices is updated.

See
PlanetKitAudioDeviceChangeDelegate
Declaration
Swift

public func didAudioDevicesUpdate(devices: [PlanetKitAudioDevice])
didAudioDeviceChange(device:type:)
Called when the audio device has changed.

See
PlanetKitAudioDeviceChangeDelegate
Declaration
Swift

public func didAudioDeviceChange(device: PlanetKitAudioDevice?, type: PlanetKitAudioDeviceType)
didAudioDeviceDataSourceChange(device:dataSource:)
Called when the audio device data source has changed.

See
PlanetKitAudioDeviceChangeDelegate
Declaration
Swift

public func didAudioDeviceDataSourceChange(device: PlanetKitAudioDevice, dataSource: UInt32)

PlanetKitCameraDeviceChangeDelegate

didCameraDeviceConnect(deviceInfo:)
Called when a camera device is connected.
Declaration
Swift

public func didCameraDeviceConnect(deviceInfo: PlanetKitVideoCaptureDeviceInfo)
didCameraDeviceDisconnect(deviceInfo:)
Called when a camera device is disconnected.
Declaration
Swift

public func didCameraDeviceDisconnect(deviceInfo: PlanetKitVideoCaptureDeviceInfo)
didCameraDeviceSelect(deviceInfo:preset:)
Called when a camera device is selected with a specific preset.
Declaration
Swift

public func didCameraDeviceSelect(deviceInfo: PlanetKitVideoCaptureDeviceInfo, preset: PlanetKitCameraPreset)

Audio/Video Change

enableVideo(initialMyVideoState:completion:)
Enables a video conference in the middle of an audio conference.
- initialMyVideoState: The initial state of the local user’s video.
- completion: A closure that will be called when the video is enabled. The closure takes a Boolean value indicating whether the video conference was enabled successfully or not.
Declaration
Swift

@objc public func enableVideo(initialMyVideoState: PlanetKitInitialMyVideoState = .resume, completion: @escaping (Bool) -> Void)
disableVideo(completion:)
Disables a video conference in the middle of a video conference.
Declaration
Swift

@objc public func disableVideo(completion: @escaping (Bool) -> Void)

Peer Video

requestPeerVideo(id:maxResolution:delegate:subgroupName:completion:)
Requests the target peer’s video.

Remark
Use the function with the resolution handler if the resulting resolution must be known. The requestPeerVideo affects call quality. Please refer to the document and use this API appropriately. https://docs.lineplanet.me/iosmacos/extended-functions/peer-video-resolution-in-group-call
Declaration
Swift

@available(*, deprecated, message: "Use startVideo(maxResolution:delegate:subgroupName:completion:﹚ of PlanetKitPeerControl instead") @objc public func requestPeerVideo(id: PlanetKitUserId, maxResolution: PlanetKitVideoResolution, delegate: PlanetKitVideoOutputDelegate, subgroupName: String? = nil, completion: @escaping (Bool) -> Void)


                    
                    
                    requestPeerVideo(id:maxResolution:delegate:subgroupName:resolution:)

Requests the target peer’s video.

Remark

The requestPeerVideo affects call quality. Please refer to the document and use this API appropriately. https://docs.lineplanet.me/iosmacos/extended-functions/peer-video-resolution-in-group-call

Declaration

Swift

@available(*, deprecated, message: "Use startVideo(maxResolution:delegate:subgroupName:resolution:﹚ of PlanetKitPeerControl instead")
@objc
public func requestPeerVideo(id: PlanetKitUserId, maxResolution: PlanetKitVideoResolution, delegate: PlanetKitVideoOutputDelegate, subgroupName: String? = nil, resolution: @escaping (_ success: Bool, _ req: PlanetKitVideoResolution, _ recv: PlanetKitVideoResolution, _ failReason: String) -> Void)


                    
                    
                    stopPeerVideo(id:subgroupName:completion:)

Stops the target peer’s video.

Remark

The operation fails if the peer’s video has already been stopped.

Declaration

Swift

@available(*, deprecated, message: "Use stopVideo(completion:﹚ of PlanetKitPeerControl instead")
@objc
public func stopPeerVideo(id: PlanetKitUserId, subgroupName: String? = nil, completion: @escaping (Bool) -> Void)

Peer Control


                    
                    
                    createPeerControl(peer:)

Creates a peer control object for the specified peer.

Declaration

Swift

@objc
public func createPeerControl(peer: PlanetKitConferencePeer) -> PlanetKitPeerControl?

Parameters


                                peer

The peer for which to create the peer control object.

Return Value

A PlanetKitPeerControl object if the creation is successful, otherwise nil.

Provider for Raw Data

sendMicData(frameCnt:sampleRate:sampleType:outData:outDataLen:)
Sends raw data.

Remark
This is functionally equivalent to PlanetKitConference.didCapture(frameCnt:channels:sampleRate:sampleType:timestamp:outData:outDataLen:) that handles the Modifier, the Receivers, and the Volume Receiver.
Declaration
Swift

@objc public func sendMicData(frameCnt: UInt32, sampleRate: UInt32, sampleType: PlanetKitAudioSampleType, outData: UnsafeMutableRawPointer!, outDataLen: UInt32)
recvSpkData(frameCnt:sampleRate:sampleType:playBuf:playBufSize:)
Receives raw data.

Remark
This is functionally equivalent to PlanetKitConference.willPlay(frameCnt:channels:sampleRate:sampleType:timestamp:playBuf:playBufSize:) that handles the Modifier, the Receivers, and the Volume Receiver.
Declaration
Swift

@objc public func recvSpkData(frameCnt: UInt32, sampleRate: UInt32, sampleType: PlanetKitAudioSampleType, playBuf: UnsafeMutableRawPointer!, playBufSize: UInt32) -> Int32

AEC Reference Data

startUserAcousticEchoCancellerReference(_:)
Starts the use of the user’s reference audio data for AEC to resolve echo.

Remark
To resolve echo using the user’s reference data, you should provide reference data using PlanetKitConference.putUserAcousticEchoCancellerReference(frameCnt:...) after calling this function.
Declaration
Swift

@objc public func startUserAcousticEchoCancellerReference(_ completion: @escaping (Bool) -> Void)
stopUserAcousticEchoCancellerReference(_:)
Stops the use of the user’s reference audio data for AEC to resolve echo.

Remark
You should call this function to stop putting reference audio data for AEC.
Declaration
Swift

@objc public func stopUserAcousticEchoCancellerReference(_ completion: @escaping (Bool) -> Void)


                    
                    
                    putUserAcousticEchoCancellerReference(frameCnt:channels:sampleRate:sampleType:outData:outDataLen:)

Puts reference audio data for AEC.

Declaration

Swift

@objc
public func putUserAcousticEchoCancellerReference(frameCnt: UInt32, channels: UInt32, sampleRate: UInt32, sampleType: PlanetKitAudioSampleType, outData: UnsafeMutableRawPointer!, outDataLen: UInt32)

PlanetKitAudioMicCaptureDelegate

didCapture(frameCnt:channels:sampleRate:sampleType:timestamp:outData:outDataLen:)
Implements the PlanetKitAudioMicCaptureDelegate to send audio data to a conference.

Do not call this function unless you have to handle mic input instead of PlanetKit.
Declaration
Swift

public func didCapture(frameCnt: UInt32, channels: UInt32, sampleRate: UInt32, sampleType: PlanetKitAudioSampleType, timestamp: AudioTimeStamp, outData: UnsafeMutableRawPointer!, outDataLen: UInt32)

PlanetKitAudioSpkPlayDelegate

willPlay(frameCnt:channels:sampleRate:sampleType:timestamp:playBuf:playBufSize:)
Implements the PlanetKitAudioSpkPlayDelegate to get audio data from a conference.

Do not call this function unless you have to handle speaker and play out instead of PlanetKit.
Declaration
Swift

public func willPlay(frameCnt: UInt32, channels: UInt32, sampleRate: UInt32, sampleType: PlanetKitAudioSampleType, timestamp: AudioTimeStamp, playBuf: UnsafeMutableRawPointer!, playBufSize: UInt32) -> Int32

PlanetKitVideoOutputDelegate

videoOutput(_:)
Implements the PlanetKitVideoOutputDelegate to send video data to a conference.

Do not call this function unless you have to handle cam output instead of PlanetKit.
Declaration
Swift

public func videoOutput(_ videoBuffer: PlanetKitVideoBuffer)

PlanetKitVideoLimiter


                    
                    
                    isScreenShareSendAvailable(_:)

Determines if screen share sending is available at the specified timestamp.

Declaration

Swift

public func isScreenShareSendAvailable(_ timestamp: CMTime) -> Bool

Parameters


                                timestamp

The timestamp of the screen share frame.

Return Value

true if screen share sending is available, false otherwise.


                    
                    
                    isVideoSendAvailable(_:)

Determines if video sending is available at the specified timestamp.

Declaration

Swift

public func isVideoSendAvailable(_ timestamp: CMTime) -> Bool

Parameters


                                timestamp

The timestamp of the video frame.

Return Value

true if video sending is available, false otherwise.

Screen Share (Sender)

startMyScreenShare(subgroupName:completion:)

Starts the local user’s screen share.


                    
                    
                    startMyScreenShare(device:subgroupName:completion:)

Starts the local user’s screen share.

Declaration

Swift

@objc
public func startMyScreenShare(device: PlanetKitScreenCaptureDevice, subgroupName: String?, completion: @escaping (Bool) -> Void)

Parameters

`device`	The screen capture device to be used for screen share.
`completion`	A closure that will be called when the screen share is started. The closure takes a Boolean value indicating whether the screen share was started successfully or not.


                    
                    
                    stopMyScreenShare(completion:)

Stops the local user’s screen share.

Declaration

Swift

@objc
public func stopMyScreenShare(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that will be called when the screen share is stopped. The closure takes a Boolean value indicating whether the screen share was stopped successfully or not.


                    
                    
                    stopMyScreenShare(reason:completion:)

Stops the local user’s screen share with a reason code.

Remark

The reason value must be between 0 and 39.

Declaration

Swift

@objc
public func stopMyScreenShare(reason: Int32, completion: @escaping (Bool) -> Void)

Parameters

`reason`	The reason for stopping the screen share.
`completion`	A closure that will be called when the screen share is stopped. The closure takes a Boolean value indicating whether the screen share was stopped successfully or not.


                    
                    
                    changeMyScreenShareDestination(subgroupName:completion:)

Changes the destination for screen share.

Declaration

Swift

@objc
public func changeMyScreenShareDestination(subgroupName: String, completion: @escaping (Bool) -> Void)

Parameters

`subgroupName`	The name of the subgroup to change the screen share destination for.
`completion`	A closure that is called when the operation is complete. The closure takes a Boolean value indicating whether the operation was successful.


                    
                    
                    changeMyScreenShareDestinationToMainRoom(completion:)

Changes the screen share destination to the main room.

Declaration

Swift

@objc
public func changeMyScreenShareDestinationToMainRoom(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that is called when the operation is complete. The closure takes a Boolean value indicating whether the operation was successful.

stopMyBroadcast()

Stops the local user’s ReplayKit session.

Close the session that receives data transmitted from ReplayKit via App Extension.

Screen Share (Receiver)


                    
                    
                    requestPeerScreenShare(peerId:subgroupName:completion:)

Requests receiving a peer’s screen share.

Declaration

Swift

@available(*, deprecated, message: "Use startScreenShare(delegate:subgroupName:completion:﹚ of PlanetKitPeerControl instead")
@objc
public func requestPeerScreenShare(peerId: PlanetKitUserId, subgroupName: String?, completion: @escaping (Bool) -> Void)


                    
                    
                    stopPeerScreenShare(peerId:subgroupName:completion:)

Stops receiving a peer’s screen share.

Declaration

Swift

@available(*, deprecated, message: "Use stopScreenShare(completion:﹚ of PlanetKitPeerControl instead")
@objc
public func stopPeerScreenShare(peerId: PlanetKitUserId, subgroupName: String?, completion: @escaping (Bool) -> Void)


                    
                    
                    addPeerScreenShareView(peerId:subgroupName:delegate:)

Adds a peer screen share view delegate.

Declaration

Swift

@objc
public func addPeerScreenShareView(peerId: PlanetKitUserId, subgroupName: String?, delegate: PlanetKitVideoOutputDelegate)

Parameters

`peerId`	The peer ID of the screen share.
`subgroupName`	The subgroup name of the screen share.
`delegate`	The delegate object conforming to the `PlanetKitVideoOutputDelegate` protocol.


                    
                    
                    removePeerScreenShareView(peerId:subgroupName:delegate:)

Removes a peer screen share view delegate.

Declaration

Swift

@objc
public func removePeerScreenShareView(peerId: PlanetKitUserId, subgroupName: String?, delegate: PlanetKitVideoOutputDelegate)

Parameters

`peerId`	The peer ID of the screen share.
`subgroupName`	The subgroup name of the screen share.
`delegate`	The delegate object conforming to the `PlanetKitVideoOutputDelegate` protocol.


                    
                    
                    removeAllPeerScreenShareView(peerId:subgroupName:)

Removes all screen share views associated with a specific peer in a given subgroup.

Note

This method only removes screen share views associated with the specified peer in the specified subgroup. If the subgroup does not exist, or if the peer is not a member of the subgroup, no action is taken.

Declaration

Swift

@objc
public func removeAllPeerScreenShareView(peerId: PlanetKitUserId, subgroupName: String?)

Parameters

`peerId`	The ID of the peer whose screen share views should be removed.
`subgroupName`	The name of the subgroup where the peer belongs.

getPeerScreenShareViews(peerId:subgroupName:)
Returns an array of PlanetKitVideoOutputDelegate objects representing the peer screen share views.
Declaration
Swift

@objc public func getPeerScreenShareViews(peerId: PlanetKitUserId, subgroupName: String?) -> [PlanetKitVideoOutputDelegate]?

Concurrent Count

peersVideoMaxCount
Gets the maximum concurrent video count.

Remark
The count of received peer videos increases with a successful startVideo(maxResolution:delegate:subgroupName:completion:) and decreases with stopVideo(completion:). If the count of concurrently received peer videos is equal to the maximum count, a new startVideo(maxResolution:delegate:subgroupName:completion:) will fail.
Declaration
Swift

@objc public var peersVideoMaxCount: Int { get }
peersScreenShareMaxCount
Gets the maximum concurrent screen share count.

Remark
The count of received peer screen shares increases with a successful startScreenShare(delegate:subgroupName:completion:) and decreases with stopScreenShare(completion:). If the count of concurrently received peer screen shares is equal to the maximum count, a new startScreenShare(delegate:subgroupName:completion:) will fail.
Declaration
Swift

@objc public var peersScreenShareMaxCount: Int { get }

Screen Share - Video Share Mode


                    
                    
                    setMyScreenShareVideoShareMode(enable:)

Sets the video share mode for the local user’s screen share.

Remark

The video share mode determines whether the local user’s video is shared during screen share. By default, the video share mode is disabled.

Declaration

Swift

@objc
public func setMyScreenShareVideoShareMode(enable: Bool) -> Bool

Parameters


                                enable

A Boolean value indicating whether the video share mode should be enabled.

Return Value

A Boolean value indicating whether the video share mode was set successfully or not.

isMyScreenShareVideoShareModeEnabled
A Boolean value indicating whether the video share mode is enabled for the local user’s screen share.
Declaration
Swift

@objc public var isMyScreenShareVideoShareModeEnabled: Bool { get }

Shared Contents


                    
                    
                    setSharedContents(data:completion:)

Sets the shared contents during a conference.

Declaration

Swift

public func setSharedContents(data: Data, completion: @escaping (Bool) -> Void)

Parameters

`data`	The data to be shared.
`completion`	A closure that will be called when the shared contents are set. The closure takes a Boolean value indicating whether the shared contents were set successfully or not.


                    
                    
                    unsetSharedContents(completion:)

Unsets the shared contents during a conference.

Declaration

Swift

public func unsetSharedContents(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that will be called when the shared contents are unset. The closure takes a Boolean value indicating whether the shared contents were unset successfully or not.


                    
                    
                    setExclusivelySharedContents(data:completion:)

Sets the exclusively shared contents during a conference.

Declaration

Swift

public func setExclusivelySharedContents(data: Data, completion: @escaping (Bool) -> Void)

Parameters

`data`	The data to be shared.
`completion`	A closure that will be called when the exclusively shared contents are set. The closure takes a Boolean value indicating whether the exclusively shared contents were set successfully or not.


                    
                    
                    unsetExclusivelySharedContents(completion:)

Unsets the exclusively shared contents during a conference.

Declaration

Swift

public func unsetExclusivelySharedContents(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that will be called when the exclusively shared contents are unset. The closure takes a Boolean value indicating whether the exclusively shared contents were unset successfully or not.


                    
                    
                    setRoomSharedContents(data:completion:)

Sets the room shared contents during a conference.

Remark

This function will not work at 1-to-1 call.

Declaration

Swift

public func setRoomSharedContents(data: Data, completion: @escaping (Bool) -> Void)

Parameters

`data`	The data to be shared.
`completion`	A closure that will be called when the room shared contents are set. The closure takes a Boolean value indicating whether the room shared contents were set successfully or not.


                    
                    
                    unsetRoomSharedContents(completion:)

Unsets the room shared contents during a conference.

Remark

This function will not work at 1-to-1 call.

Declaration

Swift

public func unsetRoomSharedContents(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that will be called when the room shared contents are unset. The closure takes a Boolean value indicating whether the room shared contents were unset successfully or not.

Short Data


                    
                    
                    sendShortData(peerId:type:data:completion:)

Sends short data to a peer in the room.

The maximum size of type is 100 bytes and the maximum size of data is 800 bytes. If the completion callback is called with false, the session is not in .connected state or the data or type exceeds the size limit.

If the short data is sent successfully, the completion callback is called with true.

Declaration

Swift

@objc
public func sendShortData(peerId: PlanetKitUserId, type: String, data: Data, completion: @escaping (Bool) -> Void)

Parameters

`peerId`	Peer to receive short data.
`type`	User-defined data type to be sent along with `data`
`data`	Data to be sent
`completion`	Completion callback to receive the result of sending short data


                    
                    
                    sendShortData(type:data:completion:)

Sends short data to all peers in the room.

If the short data is sent successfully, the completion callback is called with true.

Declaration

Swift

@objc
public func sendShortData(type: String, data: Data, completion: @escaping (Bool) -> Void)

Parameters

`type`	User-defined data type to be sent along with `data`
`data`	Data to be sent
`completion`	Completion callback to receive the result of sending short data

Statistics

statistics
The statistics of the conference.
Declaration
Swift

public var statistics: PlanetKitStatistics? { get }

Getter for Peer


                    
                    
                    isMe(peer:)

Checks if the peer is the local user.

Declaration

Swift

@objc
public func isMe(peer: PlanetKitConferencePeer) -> Bool


                    
                    
                    getPeer(peerId:)

Gets a peer object from the main room.

Declaration

Swift

@objc
public func getPeer(peerId: PlanetKitUserId) -> PlanetKitConferencePeer?

Conference Management

leaveConference()
Leaves the conference.
Declaration
Swift

@objc public func leaveConference()


                    
                    
                    hold(reason:completion:)

Holds the conference to interact with another call or OS operations.

Declaration

Swift

@objc
public func hold(reason: String?, completion: @escaping (Bool) -> Void)

Parameters


                                reason

Maximum size of reason is 255 bytes with UTF-8 encoded string.


                    
                    
                    unhold(completion:)

Unholds the conference to resume.

Declaration

Swift

@objc
public func unhold(completion: @escaping (Bool) -> Void)

Audio/Video State

isPeersAudioSilenced
Indicates whether the audio of the peer users is silenced.
Declaration
Swift

@objc public var isPeersAudioSilenced: Bool { get }
duration
Gets the call duration. If the duration is invalid, it returns -1.
Declaration
Swift

@objc public var duration: TimeInterval { get }

Peer Audio/Media Control


                    
                    
                    requestPeerMute(_:peerId:completion:)

Requests a targeted peer to mute or unmute audio.

Declaration

Swift

@objc
public func requestPeerMute(_ mute: Bool, peerId: PlanetKitUserId, completion: @escaping (Bool) -> Void)


                    
                    
                    requestPeersMute(_:completion:)

Requests all peers to mute or unmute audio.

Declaration

Swift

@objc
public func requestPeersMute(_ mute: Bool, completion: @escaping (Bool) -> Void)


                    
                    
                    pauseMyVideo(completion:)

Pauses the local user’s video during a conference.

Declaration

Swift

@objc
public func pauseMyVideo(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that is called when the video is paused. The closure takes a Boolean value that indicates whether the video was successfully paused.


                    
                    
                    resumeMyVideo(completion:)

Resumes the local user’s video during a conference.

Remark

On macOS, if there is no available camera device, the function call will fail. It may be necessary to check in advance using PlanetKitCameraManager.isCameraAvailable.

Declaration

Swift

@objc
public func resumeMyVideo(completion: @escaping (Bool) -> Void)

Parameters


                                completion

A closure that is called when the video is resumed. The closure takes a Boolean value that indicates whether the video was successfully resumed.


                    
                    
                    muteMyAudio(_:completion:)

Mutes or unmutes the local user’s audio during a conference.

Declaration

Swift

@objc
public func muteMyAudio(_ mute: Bool, completion: @escaping (Bool) -> Void)

Parameters

`mute`	A Boolean value that indicates whether to mute or unmute the audio.
`completion`	A closure that is called when the audio is muted or unmuted. The closure takes a Boolean value that indicates whether the audio was successfully muted or unmuted.

silencePeersAudio(_:completion:)
Makes all peers’ voice silent by removing speaker output.
Declaration
Swift

public func silencePeersAudio(_ silent: Bool, completion: @escaping (Bool) -> Void)

Customize setting

reload(_:)
This is debugging only function. (DO NOT USE IT)
Declaration
Swift

@objc public func reload(_ setting: [String : Any])
isOnHold
A Boolean value indicating whether the conference is on hold.
Declaration
Swift

@objc public var isOnHold: Bool { get }
myUserEquipmentType
The local user equipment type associated with the conference.
Declaration
Swift

@objc public var myUserEquipmentType: PlanetKitUserEquipmentType { get }
myDisplayName
The display name of the local user associated with the conference.
Declaration
Swift

@objc public var myDisplayName: String? { get }

Monitoring

getMonitorInfo()
Gets the monitoring information string.
Declaration
Swift

public func getMonitorInfo() -> String