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

#include <audio_cluster_descriptor.h>

Inheritance diagram for avdecc_lib::audio_cluster_descriptor:
avdecc_lib::descriptor_base

Public Member Functions

virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
signal_type ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
signal_index ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
signal_output ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
path_latency ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint32_t STDCALL 
block_latency ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint16_t STDCALL 
channel_count ()=0
 
virtual
AVDECC_CONTROLLER_LIB32_API
uint8_t STDCALL 
format ()=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 uint32_t STDCALL avdecc_lib::audio_cluster_descriptor::block_latency ( )
pure virtual
Returns
The block latency of the Audio Cluster. For an Aduio Cluster attached to a Stream Port Input, this is the latency in nanoseconds between the reference plane and the output of the cluster. For an Audio Cluster attached to a Stream Port Output, this is the latency in nanoseconds between the output of the previous block's output and the reference plane. The previous block is the object identified by the signal type and signal index fields.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::audio_cluster_descriptor::channel_count ( )
pure virtual
Returns
The number of channels within the cluster.
virtual AVDECC_CONTROLLER_LIB32_API uint8_t STDCALL avdecc_lib::audio_cluster_descriptor::format ( )
pure virtual

The format for each channel of this cluster, all channels within the cluster have the same format.

Returns
0x00 (IEC 60958) for IEC 60958 encoded Audio Cluster.
0x40 (MBLA) for Multi-bit Linear Audio.
0x80 (MIDI) for MIDI data.
0x88 (SMPTE) for SMPTE data.
virtual AVDECC_CONTROLLER_LIB32_API uint32_t STDCALL avdecc_lib::audio_cluster_descriptor::path_latency ( )
pure virtual
Returns
The latency in nanoseconds between the timing reference plane and the opposite end of the currently selected signal path. This does not include any latency added by a delay control. The path latency is used to inform smart Controllers of the extra latency to get the samples to the output, so that output across multiple entries can be sample aligned.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::audio_cluster_descriptor::signal_index ( )
pure virtual
Returns
The descriptor index for the signal source of the cluster.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::audio_cluster_descriptor::signal_output ( )
pure virtual
Returns
The index of the output of the signal source of the cluster. For a signal type of Signal Splitter or Signal Demultiplexer, this is which output of the object it is being source from, for a signal type of Matrix, this is the column the signal is from and for any other signal type this is 0.
virtual AVDECC_CONTROLLER_LIB32_API uint16_t STDCALL avdecc_lib::audio_cluster_descriptor::signal_type ( )
pure virtual
Returns
The descriptor type for the signal source of the cluster.

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