Protocols
The following protocols are available globally.
-
A protocol that provides access to various statistical information during a call.
See moreDeclaration
Swift
@objc public protocol PlanetKitStatisticsControllable
-
A protocol that defines the delegate methods for receiving video output from PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitVideoOutputDelegate
-
A delegate protocol for modifying PlanetKit video output.
This protocol defines a method that is called when a video buffer is available. The conforming class should implement this method to process the video buffer.
See moreDeclaration
Swift
@objc public protocol PlanetKitVideoModifierDelegate
-
A delegate protocol for handling audio device changes in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioDeviceChangeDelegate
-
A delegate protocol for capturing audio from a microphone in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioMicCaptureDelegate
-
A delegate protocol for handling audio playback in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioSpkPlayDelegate
-
A delegate protocol for receiving updates on the volume level of a PlanetKit audio device.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioDeviceVolumeDelegate
-
A delegate protocol for receiving updates on the audio description of the local user.
See moreDeclaration
Swift
@objc public protocol PlanetKitMyAudioDescriptionDelegate
-
A delegate protocol for receiving updates on the audio descriptions of peer users.
See moreDeclaration
Swift
@objc public protocol PlanetKitPeerAudioDescriptionDelegate
-
A delegate protocol for receiving notifications about changes in the audio route.
Implement this protocol to handle updates when the audio route changes, such as switching between different audio output devices (e.g., handset, speakerphone, headset).
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioRouteChangeDelegate
-
A delegate protocol for receiving volume change events.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioVolumeDelegate
-
A class that represents the audio speaker management for PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioSpkControllable
-
A class that represents the audio microphone management for PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitAudioMicControllable
-
Declaration
Swift
@objc public protocol PlanetKitCallHookedAudioDelegate
-
The delegate protocol for the PlanetKit call events.
See moreDeclaration
Swift
@objc public protocol PlanetKitCallDelegate
-
A protocol that defines methods for controlling shared contents in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitSharedContentsControllable
-
A delegate protocol for handling camera device changes in the PlanetKitCamera class.
See moreDeclaration
Swift
@objc public protocol PlanetKitCameraDeviceChangeDelegate
-
A protocol that defines methods for handling interruptions in the PlanetKit camera.
See more -
A protocol that defines methods for limiting video and screen share sending in the PlanetKit framework.
See moreDeclaration
Swift
@objc public protocol PlanetKitVideoLimiter
-
A protocol that defines methods for handling FPS (Frames Per Second) limit updates in the PlanetKit framework. The
PlanetKitFpsLimitUpdateDelegate
protocol should be adopted by classes or structs that want to receive updates about the optimal FPS for the PlanetKit SDK. The delegate methods provide information about whether the FPS limit is enabled and the recommended FPS value to optimize the performance ofPlanetKitCameraControllable
andPlanetKitScreenControllable
implementations.Note
The delegate methods are optional, and you can choose to implement them based on your needs.Declaration
Swift
@objc public protocol PlanetKitFpsLimitUpdateDelegate
-
A protocol that defines methods for receiving event from the camera.
See moreDeclaration
Swift
@objc public protocol PlanetKitCameraDelegate
-
Declaration
Swift
@objc public protocol PlanetKitConferenceDelegate
-
A protocol that defines the events for the peer in a conference.
See moreDeclaration
Swift
@objc public protocol PlanetKitPeerControlDelegate
-
A protocol that defines the controllable behavior of a data session in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitDataSessionControllable
-
A delegate protocol for handling outbound data session events in PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitOutboundDataSessionDelegate
-
A delegate protocol for receiving inbound data session events in the PlanetKit framework.
See moreDeclaration
Swift
@objc public protocol PlanetKitInboundDataSessionDelegate
-
A protocol that defines a debug monitor for PlanetKit.
See moreDeclaration
Swift
@objc public protocol PlanetKitDebugMonitor
-
A delegate protocol for
See morePlanetKitMTKView
that provides methods for notifying about drawing events and frame resolution changes.Declaration
Swift
@objc public protocol PlanetKitMTKViewDelegate
-
A delegate protocol for receiving video output from a PlanetKit video stream.
See moreDeclaration
Swift
@objc public protocol PlanetKitVideoStreamDelegate
-
A delegate protocol for receiving updates on the media status of the
See morePlanetKitMyMediaStatus
object.Declaration
Swift
@objc public protocol PlanetKitMyMediaStatusDelegate
-
A protocol that defines the controllable behavior of a PlanetKit screen.
See moreDeclaration
Swift
@objc public protocol PlanetKitScreenControllable : PlanetKitFpsLimitUpdateDelegate
-
A protocol that defines methods for handling interruptions in screen capture.
See moreDeclaration
Swift
@objc public protocol PlanetKitScreenInterruptDelegate
-
A protocol that allows controlling the filtering of windows in a screen capture device.
See moreDeclaration
Swift
@objc public protocol PlanetKitScreenCaptureWindowFilterControllable