This object represents a unique device for a member of a Conference or ChatRoom. More...
#include <participant_device.hh>
Public Member Functions | |
| ParticipantDevice (void *ptr, bool takeRef=true) | |
| LINPHONECXX_PUBLIC _LinphoneParticipantDevice * | cPtr () |
| LINPHONECXX_PUBLIC void | addListener (const std::shared_ptr< ParticipantDeviceListener > &listener) |
| LINPHONECXX_PUBLIC void | removeListener (const std::shared_ptr< ParticipantDeviceListener > &listener) |
| LINPHONECXX_PUBLIC std::shared_ptr< const linphone::Address > | getAddress () const |
| Get the address of a participant's device. More... | |
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceDisconnectionMethod | getDisconnectionMethod () const |
| Get the disconnection method. More... | |
| LINPHONECXX_PUBLIC std::string | getDisconnectionReason () const |
| Get the disconnection reason. More... | |
| LINPHONECXX_PUBLIC bool | isInConference () const |
| Return whether the participant device is in a conference or not. More... | |
| LINPHONECXX_PUBLIC bool | getIsMuted () const |
| Return whether the participant device is muted or not. More... | |
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceJoiningMethod | getJoiningMethod () const |
| Get the joining method or it the device is the focus owner. More... | |
| LINPHONECXX_PUBLIC std::string | getName () const |
| Return the name of the device or nullptr. More... | |
| LINPHONECXX_PUBLIC void * | getNativeVideoWindowId () const |
| Get window ID. More... | |
| LINPHONECXX_PUBLIC void | setNativeVideoWindowId (void *windowId) const |
| Set window ID for a device. More... | |
| LINPHONECXX_PUBLIC linphone::ChatRoomSecurityLevel | getSecurityLevel () const |
| Get the security level of a participant's device. More... | |
| LINPHONECXX_PUBLIC uint32_t | getSsrc () const |
| Get the SSRC of the device. More... | |
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceState | getState () const |
| Get the state of a participant device. More... | |
| LINPHONECXX_PUBLIC time_t | getTimeOfDisconnection () const |
| Get the timestamp the device left a conference. More... | |
| LINPHONECXX_PUBLIC time_t | getTimeOfJoining () const |
| Get the timestamp the device joined a conference. More... | |
| LINPHONECXX_PUBLIC void * | createNativeVideoWindowId () const |
| Create a window ID and return it. More... | |
| LINPHONECXX_PUBLIC bool | getStreamAvailability (linphone::StreamType streamType) const |
| Get the stream availability of the device. More... | |
| LINPHONECXX_PUBLIC linphone::MediaDirection | getStreamCapability (linphone::StreamType streamType) const |
| Get the stream capability of the device. More... | |
Detailed Description
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().
Member Function Documentation
◆ createNativeVideoWindowId()
| LINPHONECXX_PUBLIC void* linphone::ParticipantDevice::createNativeVideoWindowId | ( | ) | const |
Create a window ID and return it.
- Returns
- the window ID of the device
◆ getAddress()
| LINPHONECXX_PUBLIC std::shared_ptr<const linphone::Address> linphone::ParticipantDevice::getAddress | ( | ) | const |
Get the address of a participant's device.
- Returns
- The Address of the participant's device
◆ getDisconnectionMethod()
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceDisconnectionMethod linphone::ParticipantDevice::getDisconnectionMethod | ( | ) | const |
Get the disconnection method.
- Returns
- disconnection method ParticipantDeviceDisconnectionMethod
◆ getDisconnectionReason()
| LINPHONECXX_PUBLIC std::string linphone::ParticipantDevice::getDisconnectionReason | ( | ) | const |
Get the disconnection reason.
- Returns
- disconnection reason
◆ getIsMuted()
| LINPHONECXX_PUBLIC bool linphone::ParticipantDevice::getIsMuted | ( | ) | const |
Return whether the participant device is muted or not.
- Returns
- true if the participant device is muted, false otherwise.
◆ getJoiningMethod()
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceJoiningMethod linphone::ParticipantDevice::getJoiningMethod | ( | ) | const |
Get the joining method or it the device is the focus owner.
- Returns
- joining method or focus owner ParticipantDeviceJoiningMethod
◆ getName()
| LINPHONECXX_PUBLIC std::string linphone::ParticipantDevice::getName | ( | ) | const |
Return the name of the device or nullptr.
- Returns
- the name of the device or nullptr.
◆ getNativeVideoWindowId()
| LINPHONECXX_PUBLIC void* linphone::ParticipantDevice::getNativeVideoWindowId | ( | ) | const |
Get window ID.
- Returns
- the window ID of the device
◆ getSecurityLevel()
| LINPHONECXX_PUBLIC linphone::ChatRoomSecurityLevel linphone::ParticipantDevice::getSecurityLevel | ( | ) | const |
Get the security level of a participant's device.
- Returns
- The ChatRoomSecurityLevel of the device
◆ getSsrc()
| LINPHONECXX_PUBLIC uint32_t linphone::ParticipantDevice::getSsrc | ( | ) | const |
Get the SSRC of the device.
- Returns
- the SSRC of the device
◆ getState()
| LINPHONECXX_PUBLIC linphone::ParticipantDeviceState linphone::ParticipantDevice::getState | ( | ) | const |
Get the state of a participant device.
- Returns
- The ParticipantDeviceState of the device
◆ getStreamAvailability()
| LINPHONECXX_PUBLIC bool linphone::ParticipantDevice::getStreamAvailability | ( | linphone::StreamType | streamType | ) | const |
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
- Parameters
-
streamType A StreamType
- Returns
- true if the stream of type stream_type is available for device, false otherwise
◆ getStreamCapability()
| LINPHONECXX_PUBLIC linphone::MediaDirection linphone::ParticipantDevice::getStreamCapability | ( | linphone::StreamType | streamType | ) | const |
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).
- Parameters
-
streamType A StreamType
- Returns
- the capability of stream of type stream_type of the device MediaDirection
◆ getTimeOfDisconnection()
| LINPHONECXX_PUBLIC time_t linphone::ParticipantDevice::getTimeOfDisconnection | ( | ) | const |
Get the timestamp the device left a conference.
- Returns
- 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
◆ getTimeOfJoining()
| LINPHONECXX_PUBLIC time_t linphone::ParticipantDevice::getTimeOfJoining | ( | ) | const |
Get the timestamp the device joined a conference.
- Returns
- 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
◆ isInConference()
| LINPHONECXX_PUBLIC bool linphone::ParticipantDevice::isInConference | ( | ) | const |
Return whether the participant device is in a conference or not.
- Returns
- a boolean to state whether the device is in a conference
◆ setNativeVideoWindowId()
| LINPHONECXX_PUBLIC void linphone::ParticipantDevice::setNativeVideoWindowId | ( | void * | windowId | ) | const |
Set window ID for a device.
- Parameters
-
windowId the window ID of the device
The documentation for this class was generated from the following file:
- participant_device.hh
