View on GitHub
PlanetKitCallParam Class Reference
PlanetKitCallParam
@objc
public class PlanetKitCallParam : NSObjectA class representing the parameters for making a call in PlanetKit.
-
The user ID of the local user (caller).
Declaration
Swift
@objc public internal(set) var myUserId: PlanetKitUserId { get } -
The user ID of the remote user (callee).
Declaration
Swift
@objc public internal(set) var peerUserId: PlanetKitUserId { get } -
The API key for authentication.
Declaration
Swift
@objc public internal(set) var APIKey: String? { get } -
The access token for authentication.
Declaration
Swift
@objc public internal(set) var accessToken: String? { get } -
The delegate object that will receive call-related events.
Declaration
Swift
@objc public internal(set) weak var delegate: PlanetKitCallDelegate? { get } -
App server data for establishing a new call.
Remark
Maximum size ofappServerDatais 4096 bytes including null termination. If the size ofappServerDataexceed 4096 bytes,makeCall(param:settings:)will returnPlanetKitStartFailReason.tooLongAppServerData.Declaration
Swift
@objc public var appServerData: String? -
Initial media type
Declaration
Swift
@objc public var mediaType: PlanetKitMediaType -
Whether to allow the callee to use responder preparation when accepting the call.
Remark
The callee can check the caller’s parameter withPlanetKitCallDelegate.didVerify(_:peerStartMessage:peerUseResponderPreparation:). For more information, see https://docs.lineplanet.me/iosmacos/extended-functions/responder-preparation-status.Declaration
Swift
@objc public var useResponderPreparation: Bool -
Short message for initial connection (max. 200 bytes).
Remark
PlanetKitCallParam.startMessagewill be sent to the callee throughPlanetKitCallDelegate.didVerify(_:peerStartMessage:peerUseResponderPreparation:). For more information, see https://docs.lineplanet.me/iosmacos/extended-functions/call-start-message.Declaration
Swift
@objc public var startMessage: PlanetKitCallStartMessage? -
Whether to enable recording on the cloud.
Remark
DO NOT setrecordOnCloudtotruebefore consulting with the LINE Planet team. If you want to use this feature, please contact us. (https://docs.lineplanet.me/ko/help/contact)Declaration
Swift
@objc public var recordOnCloud: Bool -
The initial state of the local user’s video.
Remark
The initial state of the local user’s video when the call starts. The default value is.resume.Declaration
Swift
@objc public var initialMyVideoState: PlanetKitInitialMyVideoState -
Initializes a new
PlanetKitCallParamobject with the specified parameters.Declaration
Swift
@available(*, deprecated, message: "Due to a security reason, use init(myUserId:peerUserId:delegate:accessToken:﹚ instead") @objc public init(myUserId: PlanetKitUserId, peerUserId: PlanetKitUserId, delegate: PlanetKitCallDelegate, APIKey: String) -
Initializes a new
PlanetKitCallParamobject with the specified parameters.- myUserId: The local user’s ID.
- peerUserId: The remote user’s ID.
- delegate: The delegate object that will receive call-related events.
- accessToken: The access token for authentication.
Declaration
Swift
@objc public init(myUserId: PlanetKitUserId, peerUserId: PlanetKitUserId, delegate: PlanetKitCallDelegate, accessToken: String)