PlanetKitConferenceParam

@objc
public class PlanetKitConferenceParam : NSObject

A class representing the parameters for a PlanetKit conference.

  • The user ID of the local user.

    Declaration

    Swift

    @objc
public internal(set) var myUserId: PlanetKitUserId { get }

  • The ID of the conference room.

    Declaration

    Swift

    @objc
public internal(set) var roomId: String { get }

  • The ID of the service for the conference room.

    Declaration

    Swift

    @objc
public internal(set) var roomServiceId: String { get }

  • Represents the local user’s display name.

    Remark

    Maximum size of displayName is 128 bytes including null termination. Any trailing part of the string that exceeds the maximum size is discarded.

    Declaration

    Swift

    @objc
public internal(set) var displayName: String? { 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 conference-related events.

    Declaration

    Swift

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

  • App server data for establishing a new conference.

    Remark

    Maximum size of appServerData is 4096 bytes including null termination. If the size of appServerData exceed 4096 bytes, joinConference(param:settings:) will return PlanetKitStartFailReason.tooLongAppServerData.

    Declaration

    Swift

    @objc
public var appServerData: String?

  • Initial media type

    Declaration

    Swift

    @objc
public var mediaType: PlanetKitMediaType

  • The initial state of the local user’s video.

    Remark

    The initial state of the local user’s video when the conference starts. The default value is .resume.

    Declaration

    Swift

    @objc
public var initialMyVideoState: PlanetKitInitialMyVideoState

  • Initializes a new PlanetKitConferenceParam object with the specified parameters.

    Declaration

    Swift

    @available(*, deprecated, message: "Due to a security reason, use init(myUserId:roomId:roomServiceId:displayName:delegate:accessToken:﹚ instead")
@objc
public init(myUserId: PlanetKitUserId, roomId: String, roomServiceId: String, displayName: String?, delegate: PlanetKitConferenceDelegate, APIKey: String)

    Parameters

    myUserId

    The local user’s ID.
    roomId

    The ID of the conference room.
    roomServiceId

    The ID of the service for the conference room.
    displayName

    The local user’s display name. If the length of displayName exceeds 127 bytes, the trailing part of the string is discarded.
    delegate

    The delegate object that will receive conference-related events.
    APIKey

    The API key for authentication.

  • Initializes a new PlanetKitConferenceParam object with the specified parameters.

    Declaration

    Swift

    @objc
public init(myUserId: PlanetKitUserId, roomId: String, roomServiceId: String, displayName: String?, delegate: PlanetKitConferenceDelegate, accessToken: String)

    Parameters

    myUserId

    The local user’s ID.
    roomId

    The ID of the conference room.
    roomServiceId

    The ID of the service for the conference room.
    displayName

    The local user’s display name. If the length of displayName exceeds 127 bytes, the trailing part of the string is discarded.
    delegate

    The delegate object that will receive conference-related events.
    accessToken

    The access token for authentication.