Zephyr API Documentation  3.0.0
A Scalable Open Source RTOS
3.0.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
bt_audio_stream_ops Struct Reference

Stream operation. More...

#include <audio.h>

Data Fields

void(* configured )(struct bt_audio_stream *stream, const struct bt_codec_qos_pref *pref)
 Stream configured callback. More...
 
void(* qos_set )(struct bt_audio_stream *stream)
 Stream QoS set callback. More...
 
void(* enabled )(struct bt_audio_stream *stream)
 Stream enabled callback. More...
 
void(* started )(struct bt_audio_stream *stream)
 Stream started callback. More...
 
void(* metadata_updated )(struct bt_audio_stream *stream)
 Stream metadata updated callback. More...
 
void(* disabled )(struct bt_audio_stream *stream)
 Stream disabled callback. More...
 
void(* stopped )(struct bt_audio_stream *stream)
 Stream stopped callback. More...
 
void(* released )(struct bt_audio_stream *stream)
 Stream released callback. More...
 
void(* connected )(struct bt_audio_stream *stream)
 Stream connected callback. More...
 
void(* disconnected )(struct bt_audio_stream *stream, uint8_t reason)
 Stream disconnected callback. More...
 
void(* recv )(struct bt_audio_stream *stream, struct net_buf *buf)
 Stream audio HCI receive callback. More...
 

Detailed Description

Stream operation.

Field Documentation

◆ configured

void(* bt_audio_stream_ops::configured) (struct bt_audio_stream *stream, const struct bt_codec_qos_pref *pref)

Stream configured callback.

Configured callback is called whenever an Audio Stream has been configured.

Parameters
streamStream object that has been configured.
prefRemote QoS preferences.

◆ connected

void(* bt_audio_stream_ops::connected) (struct bt_audio_stream *stream)

Stream connected callback.

If this callback is provided it will be called when the isochronous stream is connected.

Parameters
streamThe stream that has been connected

◆ disabled

void(* bt_audio_stream_ops::disabled) (struct bt_audio_stream *stream)

Stream disabled callback.

Disabled callback is called whenever an Audio Stream has been disabled.

Parameters
streamStream object that has been disabled.

◆ disconnected

void(* bt_audio_stream_ops::disconnected) (struct bt_audio_stream *stream, uint8_t reason)

Stream disconnected callback.

If this callback is provided it will be called when the isochronous stream is disconnected, including when a connection gets rejected.

Parameters
streamThe stream that has been Disconnected
reasonHCI reason for the disconnection.

◆ enabled

void(* bt_audio_stream_ops::enabled) (struct bt_audio_stream *stream)

Stream enabled callback.

Enabled callback is called whenever an Audio Stream has been enabled.

Parameters
streamStream object that has been enabled.

◆ metadata_updated

void(* bt_audio_stream_ops::metadata_updated) (struct bt_audio_stream *stream)

Stream metadata updated callback.

Metadata Updated callback is called whenever an Audio Stream's metadata has been updated.

Parameters
streamStream object that had its metadata updated.

◆ qos_set

void(* bt_audio_stream_ops::qos_set) (struct bt_audio_stream *stream)

Stream QoS set callback.

QoS set callback is called whenever an Audio Stream Quality of Service has been set or updated.

Parameters
streamStream object that had its QoS updated.

◆ recv

void(* bt_audio_stream_ops::recv) (struct bt_audio_stream *stream, struct net_buf *buf)

Stream audio HCI receive callback.

This callback is only used if the ISO data path is HCI.

Parameters
streamStream object.
bufBuffer containing incoming audio data.

◆ released

void(* bt_audio_stream_ops::released) (struct bt_audio_stream *stream)

Stream released callback.

Released callback is called whenever a Audio Stream has been released and can be deallocated.

Parameters
streamStream object that has been released.

◆ started

void(* bt_audio_stream_ops::started) (struct bt_audio_stream *stream)

Stream started callback.

Started callback is called whenever an Audio Stream has been started and will be usable for streaming.

Parameters
streamStream object that has been started.

◆ stopped

void(* bt_audio_stream_ops::stopped) (struct bt_audio_stream *stream)

Stream stopped callback.

Stopped callback is called whenever an Audio Stream has been stopped.

Parameters
streamStream object that has been stopped.

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