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

#include <entity_descriptor.h>

Inheritance diagram for avdecc_lib::entity_descriptor:
avdecc_lib::descriptor_base

Public Member Functions

virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
entity_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
vendor_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
entity_model_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
entity_capabilities ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
talker_stream_sources ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
talker_capabilities ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
listener_stream_sinks ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
listener_capabilities ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
controller_capabilities ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
available_index ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
association_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t *STDCALL 
entity_name ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
vendor_name_string ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
model_name_string ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t *STDCALL 
firmware_version ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t *STDCALL 
group_name ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t *STDCALL 
serial_number ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
configurations_count ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
current_configuration ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
config_desc_count ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
configuration_descriptor
*STDCALL 
get_config_desc_by_index (uint16_t config_desc_index)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_set_config_cmd ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_get_config_cmd ()=0
 
- Public Member Functions inherited from avdecc_lib::descriptor_base
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
descriptor_type () const =0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
descriptor_index () const =0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t *STDCALL 
object_name ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
localized_description ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
acquire_entity_flags ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
acquire_entity_owner_entity_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
lock_entity_flags ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint64_t STDCALL 
lock_entity_locked_entity_id ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_acquire_entity_cmd (void *notification_id, uint32_t acquire_entity_flag)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_lock_entity_cmd (void *notification_id, uint32_t lock_entity_flag)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_set_name_cmd (void *notification_id, uint16_t name_index, uint16_t config_index, char *new_name)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_get_name_cmd (void *notification_id, uint16_t name_index, uint16_t config_index)=0
 

Member Function Documentation

virtual AVDECC_CONTROLLER_LIB32_API uint64_t STDCALL avdecc_lib::entity_descriptor::association_id ( )
pure virtual
Returns
The association ID for the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::available_index ( )
pure virtual
Returns
The available index of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::config_desc_count ( )
pure virtual
Returns
The number of Configuration descriptors.
See Also
configurations_count()
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::configurations_count ( )
pure virtual
Returns
The number of Configurations the device has. A device is required to have at least 1 Configuration.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::controller_capabilities ( )
pure virtual
Returns
The AVDECC Controller capabilities of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::current_configuration ( )
pure virtual
Returns
The index of the currently set Configuration.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::entity_capabilities ( )
pure virtual
Returns
The capabilities of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint64_t STDCALL avdecc_lib::entity_descriptor::entity_id ( )
pure virtual
Returns
The Entity ID of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::entity_model_id ( )
pure virtual
Returns
The AVDECC Entity model id for the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint8_t* STDCALL avdecc_lib::entity_descriptor::entity_name ( )
pure virtual
Returns
The name of the AVDECC Entity. This may be user set through the use of a SET_NAME command.
virtual AVDECC_CONTROLLER_LIB32_API uint8_t* STDCALL avdecc_lib::entity_descriptor::firmware_version ( )
pure virtual
Returns
The firmware version of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API configuration_descriptor* STDCALL avdecc_lib::entity_descriptor::get_config_desc_by_index ( uint16_t  config_desc_index)
pure virtual
Returns
The corresponding Configuration descriptorby index.
virtual AVDECC_CONTROLLER_LIB32_API uint8_t* STDCALL avdecc_lib::entity_descriptor::group_name ( )
pure virtual
Returns
The group name of the AVDECC Entity. This may be user set through the use of a SET_NAME command.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::listener_capabilities ( )
pure virtual
Returns
The AVDECC Listener capabilities of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::listener_stream_sinks ( )
pure virtual
Returns
The number of Input Streams the AVDECC Entity has. This is also the number of STREAM_INPUT descriptors the AVDECC Entity has for Input Streams.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::model_name_string ( )
pure virtual
Returns
The localized string reference pointing to the localized model name.
virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::entity_descriptor::send_get_config_cmd ( )
pure virtual

Send a GET_CONFIGURATION command to get the current configuration of the AVDECC Entity.

virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::entity_descriptor::send_set_config_cmd ( )
pure virtual

Send a SET_CONFIFURATION command to change the current configuration of the AVDECC Entity.

virtual AVDECC_CONTROLLER_LIB32_API uint8_t* STDCALL avdecc_lib::entity_descriptor::serial_number ( )
pure virtual
Returns
The serial number of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::talker_capabilities ( )
pure virtual
Returns
The AVDECC Talker capabilities of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::talker_stream_sources ( )
pure virtual
Returns
The number of Output Streams the AVDECC Entity has. This is also the number of STREAM_OUTPUT descriptors the AVDECC Entity has for Output Streams.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::entity_descriptor::vendor_id ( )
pure virtual
Returns
The vendor id of the AVDECC Entity.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::entity_descriptor::vendor_name_string ( )
pure virtual
Returns
The localized string reference pointing to the localized vendor name.

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