Lines Matching +full:reject +full:- +full:broadcast
6 * Copyright (c) 2021-2024 Nordic Semiconductor ASA
8 * SPDX-License-Identifier: Apache-2.0
24 * The Basic Audio Profile (BAP) allows for both unicast and broadcast Audio Stream control.
50 /** An invalid Broadcast ID */
208 * broadcast ISO.
324 /** Waiting for SyncInfo from Broadcast Assistant */
333 /** No periodic advertising sync transfer receiver from Broadcast Assistant */
337 /** Broadcast Isochronous Group encryption state reported by the Scan Delegator */
339 /** The Broadcast Isochronous Group not encrypted */
342 /** The Broadcast Isochronous Group broadcast code requested */
345 /** The Broadcast Isochronous Group decrypted */
348 /** The Broadcast Isochronous Group bad broadcast code */
352 /** Broadcast Audio Scan Service (BASS) specific ATT error codes */
365 * @brief Broadcast Assistant no BIS sync preference
367 * Value indicating that the Broadcast Assistant has no preference to which BIS
475 * - @ref BT_BAP_ASCS_RSP_CODE_SUCCESS
476 * - @ref BT_BAP_ASCS_RSP_CODE_CAP_UNSUPPORTED
477 * - @ref BT_BAP_ASCS_RSP_CODE_CONF_UNSUPPORTED
478 * - @ref BT_BAP_ASCS_RSP_CODE_CONF_REJECTED
479 * - @ref BT_BAP_ASCS_RSP_CODE_METADATA_UNSUPPORTED
480 * - @ref BT_BAP_ASCS_RSP_CODE_METADATA_REJECTED
481 * - @ref BT_BAP_ASCS_RSP_CODE_NO_MEM
482 * - @ref BT_BAP_ASCS_RSP_CODE_UNSPECIFIED
496 * - @ref BT_BAP_ASCS_RSP_CODE_CONF_UNSUPPORTED
497 * - @ref BT_BAP_ASCS_RSP_CODE_CONF_REJECTED
501 * - @ref BT_BAP_ASCS_RSP_CODE_SUCCESS
502 * - @ref BT_BAP_ASCS_RSP_CODE_CAP_UNSUPPORTED
503 * - @ref BT_BAP_ASCS_RSP_CODE_NO_MEM
504 * - @ref BT_BAP_ASCS_RSP_CODE_UNSPECIFIED
513 * - @ref BT_BAP_ASCS_RSP_CODE_METADATA_UNSUPPORTED
514 * - @ref BT_BAP_ASCS_RSP_CODE_METADATA_REJECTED
525 * @param r Reason field - @ref bt_bap_ascs_reason or @ref bt_audio_metadata_type (see notes in
530 /** @brief Abstract Audio Broadcast Source structure. */
533 /** @brief Abstract Audio Broadcast Sink structure. */
556 /** Represents the Broadcast Audio Scan Service receive state */
570 /** The broadcast isochronous group encryption state */
573 /** The 24-bit broadcast ID */
577 * @brief The bad broadcast code
616 * denoted by the @p recv_state. To notify the Broadcast Assistant about
626 * @return 0 in case of accept, or other value to reject.
649 * @brief Broadcast code received
651 * Broadcast code received from a broadcast assistant
654 * broadcast code.
655 * @param recv_state Pointer to the receive state the broadcast code
657 * @param broadcast_code The 16-octet broadcast code
663 * @brief Broadcast Isochronous Stream synchronize request
665 * Request from Broadcast Assistant device to modify the Broadcast
668 * Broadcast Assistant may also request fewer, or none, indexes to
672 * Broadcast Assistant requesting the sync.
677 * by the Broadcast Assistant. A value of 0
681 * @return 0 in case of accept, or other value to reject.
687 * @brief Broadcast Assistant scanning state callback
689 * Callback triggered when a Broadcast Assistant notifies the Scan Delegator about the
734 * @retval -EINVAL if @p ep or @p info are NULL
771 /** @internal Unicast or Broadcast group - Used internally */
1005 * This shall only be called for unicast streams, as broadcast streams will always be enabled once
1034 * This shall only be called for unicast streams, as broadcast streams will
1059 * @retval -EINVAL if the stream, endpoint, ISO channel or connection is NULL
1060 * @retval -EBADMSG if the stream or ISO channel is in an invalid state for connection
1061 * @retval -EOPNOTSUPP if the role of the stream is not @ref BT_HCI_ROLE_CENTRAL
1062 * @retval -EALREADY if the ISO channel is already connecting or connected
1063 * @retval -EBUSY if another ISO channel is connecting
1064 * @retval -ENOEXEC if otherwise rejected by the ISO layer
1083 * Broadcast sinks will always be started once synchronized, and broadcast
1098 * Broadcast sinks cannot be stopped.
1099 * Broadcast sources shall be stopped with bt_bap_broadcast_source_stop().
1104 * @retval -EINVAL The @p stream does not have an endpoint or a connection, of the stream's
1106 * @retval -EBADMSG The state of the @p stream endpoint is not @ref BT_BAP_EP_STATE_DISABLING
1107 * @retval -EALREADY The CIS state of the @p is not in a connected state, and thus is already
1109 * @retval -EBUSY The @p stream is busy with another operation
1110 * @retval -ENOTCONN The @p stream ACL connection is not connected
1111 * @retval -ENOMEM No memory to send request
1112 * @retval -ENOEXEC The request was rejected by GATT
1122 * Broadcast sink streams cannot be released, but can be deleted by bt_bap_broadcast_sink_delete().
1123 * Broadcast source streams cannot be released, but can be deleted by
1181 * @retval -EINVAL if the stream is invalid, if the stream is not configured for sending or if it is
1207 * values. Invalid values will reject the codec configuration request.
1209 * value is non-zero.
1227 * values. Invalid values will reject the codec configuration request.
1229 * value is non-zero.
1246 * value is non-zero.
1262 * value is non-zero.
1276 * value is non-zero.
1291 * value is non-zero.
1305 * value is non-zero.
1318 * value is non-zero.
1332 * value is non-zero.
1361 * in a non-idle state.
1388 * in a non-idle state.
1776 * @retval -EINVAL @p cb is NULL.
1777 * @retval -EEXIST @p cb is already registered.
1794 * @brief BAP Broadcast APIs
1795 * @defgroup bt_bap_broadcast BAP Broadcast APIs
1800 /** @brief Abstract Broadcast Audio Source Endpoint (BASE) subgroup structure. */
1802 /** @brief Abstract Broadcast Audio Source Endpoint (BASE) structure. */
1805 /** Codec ID structure for a Broadcast Audio Source Endpoint (BASE) */
1815 /** BIS structure for each BIS in a Broadcast Audio Source Endpoint (BASE) subgroup */
1840 * @retval -EINVAL if arguments are invalid
1850 * @retval -EINVAL if arguments are invalid
1851 * @retval The 24-bit presentation delay value
1860 * @retval -EINVAL if arguments are invalid
1861 * @retval The 8-bit subgroup count value
1869 * @param[out] bis_indexes 32-bit BIS index bitfield that will be populated
1871 * @retval -EINVAL if arguments are invalid
1883 * @retval -EINVAL if arguments are invalid
1884 * @retval -ECANCELED if iterating over the subgroups stopped prematurely by @p func
1898 * @retval -EINVAL if arguments are invalid
1910 * @retval -EINVAL if arguments are invalid
1922 * @retval -EINVAL if arguments are invalid
1934 * @retval -EINVAL if arguments are invalid
1935 * @retval -ENOMEM if the @p codec_cfg cannot store the @p subgroup codec data
1946 * @retval -EINVAL if arguments are invalid
1947 * @retval The 8-bit BIS count value
1955 * @param[out] bis_indexes 32-bit BIS index bitfield that will be populated
1957 * @retval -EINVAL if arguments are invalid
1970 * @retval -EINVAL if arguments are invalid
1971 * @retval -ECANCELED if iterating over the subgroups stopped prematurely by @p func
1988 * @retval -EINVAL if arguments are invalid
1989 * @retval -ENOMEM if the @p codec_cfg cannot store the @p subgroup codec data
1998 * @brief BAP Broadcast Source APIs
1999 * @defgroup bt_bap_broadcast_source BAP Broadcast Source APIs
2005 * @brief Struct to hold the Broadcast Source callbacks
2011 * @brief The Broadcast Source has started and all of the streams are ready for audio data
2013 * @param source The started Broadcast Source
2018 * @brief The Broadcast Source has stopped and none of the streams are ready for audio data
2020 * @param source The stopped Broadcast Source
2021 * @param reason The reason why the Broadcast Source stopped (see the BT_HCI_ERR_* values)
2030 * @brief Registers callbacks for Broadcast Sources
2035 * @retval -EINVAL if @p cb is NULL
2036 * @retval -EEXIST if @p cb is already registered
2041 * @brief Unregisters callbacks for Broadcast Sources
2046 * @retval -EINVAL if @p cb is NULL
2047 * @retval -ENOENT if @p cb is not registered
2051 /** Broadcast Source stream parameters */
2069 /** Broadcast Source subgroup parameters*/
2081 /** Broadcast Source create parameters */
2093 * @brief Broadcast Source packing mode.
2105 * @brief Broadcast code
2111 * The string "Broadcast Code" shall be
2127 * @brief Pre-transmission offset
2129 * Offset used for pre-transmissions.
2147 * @brief Create audio broadcast source.
2149 * Create a new audio broadcast source with one or more audio streams.
2151 * The broadcast source will be visible for scanners once this has been called,
2157 * @param[in] param Pointer to parameters used to create the broadcast source.
2158 * @param[out] source Pointer to the broadcast source created
2166 * @brief Reconfigure audio broadcast source.
2168 * Reconfigure an audio broadcast source with a new codec and codec quality of
2171 * Since this may modify the Broadcast Audio Source Endpoint (BASE),
2175 * the Broadcast Source, only the first @p param.params_count subgroups are updated. If a stream
2177 * the only way to remove a stream from a Broadcast Source is to recreate the Broadcast Source).
2179 * @param source Pointer to the broadcast source
2180 * @param param Pointer to parameters used to reconfigure the broadcast source.
2188 * @brief Modify the metadata of an audio broadcast source.
2190 * Modify the metadata an audio broadcast source. This can only be done when the source is started.
2193 * @param source Pointer to the broadcast source.
2203 * @brief Start audio broadcast source.
2205 * Start an audio broadcast source with one or more audio streams.
2206 * The broadcast source will start advertising BIGInfo, and audio data can be streamed.
2208 * @param source Pointer to the broadcast source
2217 * @brief Stop audio broadcast source.
2219 * Stop an audio broadcast source.
2220 * The broadcast source will stop advertising BIGInfo, and audio data can no longer be streamed.
2222 * @param source Pointer to the broadcast source
2229 * @brief Delete audio broadcast source.
2231 * Delete an audio broadcast source.
2232 * The broadcast source will stop advertising entirely, and the source can no longer be used.
2234 * @param source Pointer to the broadcast source
2241 * @brief Get the Broadcast Audio Stream Endpoint of a broadcast source
2243 * This will encode the BASE of a broadcast source into a buffer, that can be used for
2244 * advertisement. The encoded BASE will thus be encoded as little-endian. The BASE shall be put into
2249 * @param source Pointer to the broadcast source.
2260 * @brief BAP Broadcast Sink APIs
2261 * @defgroup bt_bap_broadcast_sink BAP Broadcast Sink APIs
2266 /** Broadcast Audio Sink callback structure */
2269 * @brief Broadcast Audio Source Endpoint (BASE) received
2275 * @param base Broadcast Audio Source Endpoint (BASE).
2282 * @brief Broadcast sink is syncable
2284 * Called whenever a broadcast sink is not synchronized to audio, but the audio is
2296 * @brief The Broadcast Sink has started and audio data may be received from all of the
2299 * @param sink The started Broadcast Sink
2304 * @brief The Broadcast Sink has stopped and none of the streams will receive audio data
2306 * @param sink The stopped Broadcast Sink
2307 * @param reason The reason why the Broadcast Sink stopped (see the BT_HCI_ERR_* values)
2316 * @brief Register Broadcast sink callbacks
2322 * @param cb Broadcast sink callback structure.
2325 * @retval -EINVAL if @p cb is NULL
2326 * @retval -EALREADY if @p cb was already registered
2331 * @brief Create a Broadcast Sink from a periodic advertising sync
2334 * is from a Broadcast Source.
2336 * The created Broadcast Sink will need to be supplied to
2337 * bt_bap_broadcast_sink_sync() in order to synchronize to the broadcast audio.
2339 * bt_bap_broadcast_sink_cb.pa_synced() will be called with the Broadcast
2343 * @param broadcast_id 24-bit broadcast ID.
2344 * @param[out] sink Pointer to the Broadcast Sink created.
2359 * @param broadcast_code The 16-octet broadcast code. Shall be supplied if the broadcast is
2365 * The string "Broadcast Code" shall be
2375 * @brief Stop audio broadcast sink.
2377 * Stop an audio broadcast sink.
2378 * The broadcast sink will stop receiving BIGInfo, and audio data can no longer be streamed.
2380 * @param sink Pointer to the broadcast sink
2387 * @brief Release a broadcast sink
2389 * Once a broadcast sink has been allocated after the pa_synced callback, it can be deleted using
2390 * this function. If the sink has synchronized to any broadcast audio streams, these must first be
2404 * Register the scan deligator and Broadcast Audio Scan Service (BASS)
2419 * Unregister the scan deligator and Broadcast Audio Scan Service (BASS)
2430 * notifying Broadcast Assistants.
2461 /** The broadcast isochronous group encryption state */
2464 /** The 24-bit broadcast ID */
2480 * If @kconfig{CONFIG_BT_BAP_BROADCAST_SINK} is enabled, any Broadcast Sink
2494 /** The broadcast isochronous group encryption state */
2497 /** The 24-bit broadcast ID */
2518 * If @kconfig{CONFIG_BT_BAP_BROADCAST_SINK} is enabled, any Broadcast Sink
2533 * If @kconfig{CONFIG_BT_BAP_BROADCAST_SINK} is enabled, any Broadcast Sink
2587 * @brief Struct to hold the Basic Audio Profile Broadcast Assistant callbacks
2596 * Broadcast Audio Scan Service.
2605 * @brief Callback function for Broadcast Audio Scan Service client scan results
2611 * @param broadcast_id 24-bit broadcast ID.
2621 * @param conn The connection to the Broadcast Audio Scan Service server.
2631 * @param conn The connection to the Broadcast Audio Scan Service server.
2689 * @brief Discover Broadcast Audio Scan Service on the server.
2697 * @retval -EINVAL @p conn is NULL
2698 * @retval -EBUSY Another operation is already in progress for this @p conn
2699 * @retval -ENOTCONN @p conn is not connected
2700 * @retval -ENOMEM Could not allocated memory for the request
2701 * @retval -ENOEXEC Unexpected GATT error
2708 * This will let the Broadcast Audio Scan Service server know that this device
2709 * is actively scanning for broadcast sources.
2716 * @param conn Connection to the Broadcast Audio Scan Service server.
2722 * @retval -EINVAL @p conn is NULL of if @p conn has not done discovery
2723 * @retval -EBUSY Another operation is already in progress for this @p conn
2724 * @retval -EAGAIN Bluetooth has not been enabled.
2725 * @retval -ENOTCONN @p conn is not connected
2726 * @retval -ENOMEM Could not allocated memory for the request
2727 * @retval -ENOEXEC Unexpected scan or GATT error
2738 * @retval -EINVAL @p conn is NULL of if @p conn has not done discovery
2739 * @retval -EBUSY Another operation is already in progress for this @p conn
2740 * @retval -EAGAIN Bluetooth has not been enabled.
2741 * @retval -ENOTCONN @p conn is not connected
2742 * @retval -ENOMEM Could not allocated memory for the request
2743 * @retval -ENOEXEC Unexpected scan or GATT error
2748 * @brief Registers the callbacks used by Broadcast Audio Scan Service client.
2753 * @retval -EINVAL if @p cb is NULL
2754 * @retval -EALREADY if @p cb was already registered
2759 * @brief Unregisters the callbacks used by the Broadcast Audio Scan Service client.
2764 * @retval -EINVAL if @p cb is NULL
2765 * @retval -EALREADY if @p cb was not registered
2770 /** Parameters for adding a source to a Broadcast Audio Scan Service server */
2781 /** 24-bit broadcast ID */
2797 * let the broadcast sink decide which BIS to synchronize to.
2809 * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or if @p param is invalid
2810 * @retval -EBUSY Another operation is already in progress for this @p conn
2811 * @retval -ENOTCONN @p conn is not connected
2812 * @retval -ENOMEM Could not allocated memory for the request
2813 * @retval -ENOEXEC Unexpected scan or GATT error
2847 * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or if @p param is invalid
2848 * @retval -EBUSY Another operation is already in progress for this @p conn
2849 * @retval -ENOTCONN @p conn is not connected
2850 * @retval -ENOMEM Could not allocated memory for the request
2851 * @retval -ENOEXEC Unexpected scan or GATT error
2857 * @brief Set a broadcast code to the specified receive state.
2861 * @param broadcast_code The broadcast code.
2864 * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2865 * @retval -EBUSY Another operation is already in progress for this @p conn
2866 * @retval -ENOTCONN @p conn is not connected
2867 * @retval -ENOMEM Could not allocated memory for the request
2868 * @retval -ENOEXEC Unexpected scan or GATT error
2881 * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2882 * @retval -EBUSY Another operation is already in progress for this @p conn
2883 * @retval -ENOTCONN @p conn is not connected
2884 * @retval -ENOMEM Could not allocated memory for the request
2885 * @retval -ENOEXEC Unexpected scan or GATT error
2897 * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2898 * @retval -EBUSY Another operation is already in progress for this @p conn
2899 * @retval -ENOTCONN @p conn is not connected
2900 * @retval -ENOMEM Could not allocated memory for the request
2901 * @retval -ENOEXEC Unexpected scan or GATT error