AVDECC Controller  v0.4.8
 All Classes Namespaces Files Functions Enumerations Enumerator Macros
Public Member Functions | List of all members
avdecc_lib::end_station Class Referenceabstract

#include <end_station.h>

Public Member Functions

virtual
AVDECC_CONTROLLER_LIB32_API
const char STDCALL 
get_connection_status () const =0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
guid ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
mac ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
entity_desc_count ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
entity_descriptor *STDCALL 
get_entity_desc_by_index (uint32_t entity_desc_index)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_read_desc_cmd (void *notification_id, uint16_t desc_type, uint16_t desc_index)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_entity_avail_cmd (void *notification_id)=0
 

Member Function Documentation

virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::end_station::entity_desc_count ( )
pure virtual
Returns
The number of Entity descriptors for this End Station.
virtual AVDECC_CONTROLLER_LIB32_API const char STDCALL avdecc_lib::end_station::get_connection_status ( ) const
pure virtual
Returns
The status of the End Station connection. 'C' if connected. An End Station is connected after capturing an ADP packet with a different and unique entity GUID. 'D' if disconnected. An End Station is disconnected after it fails to advertise through ADP for 62,000 milliseconds.
virtual AVDECC_CONTROLLER_LIB32_API entity_descriptor* STDCALL avdecc_lib::end_station::get_entity_desc_by_index ( uint32_t  entity_desc_index)
pure virtual
Returns
The corresponding ENTITY descriptor by index.
virtual AVDECC_CONTROLLER_LIB32_API uint64_t STDCALL avdecc_lib::end_station::guid ( )
pure virtual
Returns
The GUID of the End Station.
virtual AVDECC_CONTROLLER_LIB32_API uint64_t STDCALL avdecc_lib::end_station::mac ( )
pure virtual
Returns
The source MAC address of the End Station.
virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::end_station::send_entity_avail_cmd ( void *  notification_id)
pure virtual

Send a ENTITY_AVAILABLE command to verify that an AVDECC Entity is still available and responding to commands.

Parameters
notification_idA void pointer to the unique identifier associated with the command.
virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::end_station::send_read_desc_cmd ( void *  notification_id,
uint16_t  desc_type,
uint16_t  desc_index 
)
pure virtual

Send a READ_DESCRIPTOR command to read a descriptor from an AVDECC Entity. Reading a descriptor can be performed by any AVDECC Controller even when the AVDECC Entityis locked or acquired as the act of reading the descriptor does not affect the AVDECC Entity state.

Parameters
notification_idA void pointer to the unique identifier associated with the command.
desc_typeThe type of the descriptor to be read by the command.
desc_indexThe index of the descriptor to be read by the command.

The documentation for this class was generated from the following file: