ParticipantDevice

public class ParticipantDevice : LinphoneObject

This object represents a unique device for a member of a Conference or/// ChatRoom. Devices are identified by the gruu parameter inside the Address which can be obtained by getAddress(). It is specially usefull to know the security level of each device inside an end-to-end encrypted ChatRoom. You can get a list of all ParticipantDevice using Participant.getDevices().

  • Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> ParticipantDevice

  • Declaration

    Swift

    public var getCobject: OpaquePointer? { get }

  • Declaration

    Swift

    public func addDelegate(delegate: ParticipantDeviceDelegate)

  • Declaration

    Swift

    public func removeDelegate(delegate: ParticipantDeviceDelegate)

  • Get the address of a participant’s device.

    Declaration

    Swift

    public var address: Address? { get }

    Return Value

    The Address of the participant’s device

  • Gets the current LinphoneParticipantDeviceCbs.

    Declaration

    Swift

    public var currentDelegate: ParticipantDeviceDelegate? { get }

    Return Value

    The LinphoneParticipantDeviceCbs that has called the last callback.

  • Get the disconnection method.

    Declaration

    Swift

    public var disconnectionMethod: ParticipantDeviceDisconnectionMethod { get }

    Return Value

    disconnection method ParticipantDeviceDisconnectionMethod

  • Get the disconnection reason.

    Declaration

    Swift

    public var disconnectionReason: String { get }

    Return Value

    disconnection reason

  • Return whether the participant device is in a conference or not.

    Declaration

    Swift

    public var isInConference: Bool { get }

    Return Value

    a boolean to state whether the device is in a conference

  • Return whether the participant device is muted or not.

    Declaration

    Swift

    public var isMuted: Bool { get }

    Return Value

    true if the participant device is muted, false otherwise.

  • Return whether the participant device is speaking or not.

    Declaration

    Swift

    public var isSpeaking: Bool { get }

    Return Value

    true if the participant device is speaking, false otherwise.

  • Get the joining method or it the device is the focus owner.

    Declaration

    Swift

    public var joiningMethod: ParticipantDeviceJoiningMethod { get }

    Return Value

    joining method or focus owner ParticipantDeviceJoiningMethod

  • Return the name of the device or nil.

    Declaration

    Swift

    public var name: String { get }

    Return Value

    the name of the device or nil.

  • Set window ID for a device.

    Declaration

    Swift

    public var nativeVideoWindowId: UnsafeMutableRawPointer? { get set }

    Return Value

    the window ID of the device

  • Get the security level of a participant’s device.

    Declaration

    Swift

    public var securityLevel: ChatRoomSecurityLevel { get }

    Return Value

    The ChatRoomSecurityLevel of the device

  • Get the state of a participant device.

    Declaration

    Swift

    public var state: ParticipantDeviceState { get }

    Return Value

    The ParticipantDeviceState of the device

  • Get the timestamp the device left a conference.

    Declaration

    Swift

    public var timeOfDisconnection: time_t { get }

    Return Value

    time of disconnection a conference as returned by time(nullptr). For UNIX based systems it is the number of seconds since 00:00hours of the 1st of January 1970

  • Get the timestamp the device joined a conference.

    Declaration

    Swift

    public var timeOfJoining: time_t { get }

    Return Value

    time of joining a conference as returned by time(nullptr). For UNIX based systems it is the number of seconds since 00:00hours of the 1st of January 1970

  • Assign a user pointer to the participant’s device.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Return Value

    The user pointer associated with the participant’s device.

  • Create a window ID and return it.

    Declaration

    Swift

    public func createNativeVideoWindowId() throws -> UnsafeMutableRawPointer

    Return Value

    the window ID of the device

  • Get the audio stream SSRC of the device.

    Declaration

    Swift

    public func getSsrc(streamType: StreamType) -> UInt32

    Parameters

    streamType

    Return Value

    the audio stream SSRC of the device

  • Get the stream availability of the device. The availability information represents whether a given stream type is currently available to be presented in the conference for a ParticipantDevice

    Declaration

    Swift

    public func getStreamAvailability(streamType: StreamType) -> Bool

    Parameters

    streamType

    Return Value

    true if the stream of type stream_type is available for device, false otherwise

  • Get the stream capability of the device. The capability information represents the capability for the #ParticipantDevice to handle a given stream type (audio, video or text).

    Declaration

    Swift

    public func getStreamCapability(streamType: StreamType) -> MediaDirection

    Parameters

    streamType

    Return Value

    the capability of stream of type stream_type of the device MediaDirection