|
1 | | -/** @file |
2 | | - * @brief Header for Bluetooth TMAP. |
| 1 | +/** |
| 2 | + * @file |
| 3 | + * @brief Header for Bluetooth TMAP. |
3 | 4 | * |
4 | 5 | * Copyright 2023 NXP |
| 6 | + * Copyright (c) 2024 Nordic Semiconductor ASA |
5 | 7 | * |
6 | 8 | * SPDX-License-Identifier: Apache-2.0 |
7 | 9 | */ |
|
47 | 49 |
|
48 | 50 | /** @brief TMAP Role characteristic */ |
49 | 51 | enum bt_tmap_role { |
| 52 | + /** |
| 53 | + * @brief TMAP Call Gateway role |
| 54 | + * |
| 55 | + * This role is defined to telephone and VoIP applications using the Call Control Profile |
| 56 | + * to control calls on a remote TMAP Call Terminal. |
| 57 | + * Audio streams in this role are typically bi-directional. |
| 58 | + */ |
50 | 59 | BT_TMAP_ROLE_CG = BIT(0), |
| 60 | + /** |
| 61 | + * @brief TMAP Call Terminal role |
| 62 | + * |
| 63 | + * This role is defined to telephone and VoIP applications using the Call Control Profile |
| 64 | + * to expose calls to remote TMAP Call Gateways. |
| 65 | + * Audio streams in this role are typically bi-directional. |
| 66 | + */ |
51 | 67 | BT_TMAP_ROLE_CT = BIT(1), |
| 68 | + /** |
| 69 | + * @brief TMAP Unicast Media Sender role |
| 70 | + * |
| 71 | + * This role is defined send media audio to TMAP Unicast Media Receivers. |
| 72 | + * Audio streams in this role are typically uni-directional. |
| 73 | + */ |
52 | 74 | BT_TMAP_ROLE_UMS = BIT(2), |
| 75 | + /** |
| 76 | + * @brief TMAP Unicast Media Receiver role |
| 77 | + * |
| 78 | + * This role is defined receive media audio to TMAP Unicast Media Senders. |
| 79 | + * Audio streams in this role are typically uni-directional. |
| 80 | + */ |
53 | 81 | BT_TMAP_ROLE_UMR = BIT(3), |
| 82 | + /** |
| 83 | + * @brief TMAP Broadcast Media Sender role |
| 84 | + * |
| 85 | + * This role is defined send media audio to TMAP Broadcast Media Receivers. |
| 86 | + * Audio streams in this role are always uni-directional. |
| 87 | + */ |
54 | 88 | BT_TMAP_ROLE_BMS = BIT(4), |
| 89 | + /** |
| 90 | + * @brief TMAP Broadcast Media Receiver role |
| 91 | + * |
| 92 | + * This role is defined send media audio to TMAP Broadcast Media Senders. |
| 93 | + * Audio streams in this role are always uni-directional. |
| 94 | + */ |
55 | 95 | BT_TMAP_ROLE_BMR = BIT(5), |
56 | 96 | }; |
57 | 97 |
|
58 | 98 | /** @brief TMAP callback structure. */ |
59 | 99 | struct bt_tmap_cb { |
60 | | - /** @brief TMAP discovery complete callback |
| 100 | + /** |
| 101 | + * @brief TMAP discovery complete callback |
61 | 102 | * |
62 | | - * This callback notifies the application about the value of the |
63 | | - * TMAP Role characteristic on the peer. |
| 103 | + * This callback notifies the application about the value of the |
| 104 | + * TMAP Role characteristic on the peer. |
64 | 105 | * |
65 | | - * @param role Peer TMAP role(s). |
66 | | - * @param conn Pointer to the connection |
67 | | - * @param err 0 if success, ATT error received from server otherwise. |
| 106 | + * @param role Peer TMAP role(s). |
| 107 | + * @param conn Pointer to the connection |
| 108 | + * @param err 0 if success, ATT error received from server otherwise. |
68 | 109 | */ |
69 | 110 | void (*discovery_complete)(enum bt_tmap_role role, struct bt_conn *conn, int err); |
70 | 111 | }; |
|
0 commit comments