<< >>

AVB Sink Control

void get_avb_sink_channels(unsigned sink_num, unsigned &n)

Get the number of channels of an AVB sink.

Parameters:

• sink_num – the number of the sink
• n – the number of channels

void set_avb_sink_channels(unsigned sink_num, unsigned n)

Set the number of channels of an AVB sink.

Sets the number of channels of an AVB sink.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – the number of the sink
• n – the number of channels

void get_avb_sink_map(unsigned sink_num, unsigned map[], unsigned &len)

Get the map of an AVB sink.

Parameters:

• sink_num – the number of the sink
• map – array containing the media output FIFOs that the stream will be split into
• len – the length of the map; should equal to the number of channels in the stream

void set_avb_sink_map(unsigned sink_num, unsigned map[], unsigned len)

Set the map of an AVB sink.

Sets the map i.e. the mapping from the 1722 stream to output FIFOs.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – the number of the sink
• map – array containing the media output FIFOs that the stream will be split into
• len – the length of the map; should equal to the number of channels in the stream

void get_avb_sink_sync(unsigned sink_num, unsigned &sync)

Get the media clock sync of an AVB sink.

Parameters:

• sink_num – the number of the sink
• sync – the media clock number of the sink

void set_avb_sink_sync(unsigned sink_num, unsigned sync)

Set the media clock sync of an AVB sink.

Sets which media clock is used to synchronize the incoming stream.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – the number of the sink
• sync – the media clock number of the sink

void get_avb_sink_name(unsigned sink_num, char name[])

Get the name of an AVB sink.

Parameters:

• sink_num – the number of the sink
• name – the name string

void set_avb_sink_name(unsigned sink_num, char name[])

Set the name of an AVB sink.

Sets the name of the sink (to be reported by higher level protocols).

Parameters:

• sink_num – the number of the sink
• name – the name string

void get_avb_sink_id(unsigned sink_num, unsigned streamId[])

Get the stream id that an AVB sink listens to.

Parameters:

• sink_num – the number of the sink
• streamId – int array containing the 64-bit of the stream

void set_avb_sink_id(unsigned sink_num, unsigned streamId[])

Set the stream id that an AVB sink listens to.

Sets the stream id that an AVB sink listens to.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – the number of the sink
• streamId – int array containing the 64-bit of the stream

void get_avb_sink_addr(unsigned sink_num, char addr[], unsigned &len)

Get the incoming destination mac address of an avb sink.

Parameters:

• sink_num – The local sink number
• addr – The mac address as an array of 6 bytes.
• len – The length of the address, should always be equal to 6.

void set_avb_sink_addr(unsigned sink_num, char addr[], unsigned len)

Set the incoming destination mac address of an avb sink.

Set the incoming destination mac address of a sink. This needs to be set if the address is a multicast address so the endpoint can register for that multicast group with the switch.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – The local sink number
• addr – The mac address as an array of 6 bytes.
• len – The length of the address, should always be equal to 6.

void get_avb_sink_vlan(unsigned sink_num, unsigned &vlan)

Get the virtual lan id of an AVB sink.

Parameters:

• sink_num – the number of the sink
• vlan – the vlan id of the sink

void set_avb_sink_vlan(unsigned sink_num, unsigned vlan)

Set the virtual lan id of an AVB sink.

Sets the vlan id of the incoming stream.

This setting will not take effect until the next time the sink state moves from disabled to potential.

Parameters:

• sink_num – the number of the sink
• vlan – the vlan id of the sink

avb_sink_state_t

Enum Values:

AVB_SINK_STATE_DISABLED

AVB_SINK_STATE_POTENTIAL

AVB_SINK_STATE_ENABLED

void get_avb_sink_state(unsigned sink_num, avb_sink_state_t state)

Get the state of an AVB sink.

Parameters:

• sink_num – the number of the sink
• state – the state of the sink

void set_avb_sink_state(unsigned sink_num, avb_sink_state_t state)

Set the state of an AVB sink.

Sets the current state of an AVB sink. You cannot set the state to ENABLED. Changing the state to POTENTIAL turns the stream on and it will automatically change to ENABLED when connected to a talker and receiving samples.

Parameters:

• sink_num – the number of the sink
• state – the state of the sink