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

#include <clock_domain_descriptor.h>

Inheritance diagram for avdecc_lib::clock_domain_descriptor:
avdecc_lib::descriptor_base

Public Member Functions

virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
clock_source_index ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
clock_sources_count ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
get_clock_source_by_index (uint32_t clk_src_index)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
set_clock_source_clock_source_index ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
get_clock_source_clock_source_index ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_set_clock_source_cmd (void *notification_id, uint16_t new_clk_src_index)=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
int STDCALL 
send_get_clock_source_cmd (void *notification_id)=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 uint16_t STDCALL avdecc_lib::clock_domain_descriptor::clock_source_index ( )
pure virtual
Returns
The descriptor index of the CLOCK SOURCE descriptor describing the current CLOCK SOURCE for the CLOCK DOMAIN.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::clock_domain_descriptor::clock_sources_count ( )
pure virtual
Returns
The number of CLOCK SOURCE indexes in the clock sources field. The maximum value for this field is 249 for this version of AEM.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::clock_domain_descriptor::get_clock_source_by_index ( uint32_t  clk_src_index)
pure virtual
Returns
The corresponding Clock Sources by index present in the CLOCK DOMAIN.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::clock_domain_descriptor::get_clock_source_clock_source_index ( )
pure virtual
Returns
The CLOCK SOURCE index of the requested CLOCK DOMAIN after sending a GET_CLOCK_SOURCE command and receiving a response back for the command.
virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::clock_domain_descriptor::send_get_clock_source_cmd ( void *  notification_id)
pure virtual

Send a GET_CLOCK_SOURCE command to get the current CLOCK SOURCE of a CLOCK DOMAIN.

Parameters
notification_idA void pointer to the unique identifier associated with the command.

The CLOCK SOURCE index can be retrieved by calling the following function after successfully receiving a response back for the GET_CLOCK_SOURCE command sent.

See Also
get_clock_source_clock_source_index()
virtual AVDECC_CONTROLLER_LIB32_API int STDCALL avdecc_lib::clock_domain_descriptor::send_set_clock_source_cmd ( void *  notification_id,
uint16_t  new_clk_src_index 
)
pure virtual

Send a SET_CLOCK_SOURCE command to change the CLOCK SOURCE of a CLOCK DOMAIN.

Parameters
notification_idA void pointer to the unique identifier associated with the command.
new_clk_src_indexThe CLOCK SOURCE index field is set to the new CLOCK SOURCE index.

The new CLOCK SOURCE index can be retrieved by calling the following function after successfully receiving a response back for the SET_CLOCK_SOURCE command sent.

See Also
set_clock_source_clock_source_index()
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::clock_domain_descriptor::set_clock_source_clock_source_index ( )
pure virtual
Returns
The CLOCK SOURCE index of the requested CLOCK DOMAIN after sending a SET_CLOCK_SOURCE command and receiving a response back for the command.

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