Object Transfer Service Client API
#include "src/ble/gatt-service/object_transfer_service_client.h"
object_transfer_service_client_init
void object_transfer_service_client_init(void);
Initialize Object Transfer Service.
object_transfer_service_client_connect
uint8_t object_transfer_service_client_connect(
hci_con_handle_t con_handle,
btstack_packet_handler_t packet_handler,
ots_client_connection_t * connection,
uint16_t service_start_handle, uint16_t service_end_handle,
uint16_t * ots_cid);
Connect to Object Transfer Service of remote device. The client will automatically register for notifications.
Event LEAUDIO_SUBEVENT_OTS_CLIENT_CONNECTED is emitted with status ERROR_CODE_SUCCESS on success, otherwise GATT_CLIENT_IN_WRONG_STATE, ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no media control service is found, or ATT errors (see bluetooth.h).
Parameters
- con_handle
- packet_handler
- connection
- service_start_handle
- service_end_handle
- ots_cid
Returns
- uint8_t: status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_COMMAND_DISALLOWED if there is already a client associated with con_handle, or BTSTACK_MEMORY_ALLOC_FAILED
object_transfer_service_client_connect_secondary_service
uint8_t object_transfer_service_client_connect_secondary_service(
hci_con_handle_t con_handle,
btstack_packet_handler_t packet_handler,
uint16_t service_start_handle, uint16_t service_end_handle, uint8_t service_index,
ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_ots_feature
uint8_t object_transfer_service_client_read_ots_feature(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_name
uint8_t object_transfer_service_client_read_object_name(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_long_object_name
uint8_t object_transfer_service_client_read_long_object_name(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_type
uint8_t object_transfer_service_client_read_object_type(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_size
uint8_t object_transfer_service_client_read_object_size(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_first_created
uint8_t object_transfer_service_client_read_object_first_created(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_last_modified
uint8_t object_transfer_service_client_read_object_last_modified(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_id
uint8_t object_transfer_service_client_read_object_id(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_properties
uint8_t object_transfer_service_client_read_object_properties(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_list_filter_1
uint8_t object_transfer_service_client_read_object_list_filter_1(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_list_filter_2
uint8_t object_transfer_service_client_read_object_list_filter_2(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_list_filter_3
uint8_t object_transfer_service_client_read_object_list_filter_3(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_long_list_filter_1
uint8_t object_transfer_service_client_read_object_long_list_filter_1(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_long_list_filter_2
uint8_t object_transfer_service_client_read_object_long_list_filter_2(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read_object_long_list_filter_3
uint8_t object_transfer_service_client_read_object_long_list_filter_3(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_write_object_name
uint8_t object_transfer_service_client_write_object_name(ots_client_connection_t * connection, const char * name);
Returns
- uint8_t
object_transfer_service_client_write_object_first_created
uint8_t object_transfer_service_client_write_object_first_created(ots_client_connection_t * connection, btstack_utc_t * date);
Returns
- uint8_t
object_transfer_service_client_write_object_last_modified
uint8_t object_transfer_service_client_write_object_last_modified(ots_client_connection_t * connection, btstack_utc_t * date);
Returns
- uint8_t
object_transfer_service_client_write_object_properties
uint8_t object_transfer_service_client_write_object_properties(ots_client_connection_t * connection, uint32_t properties);
Returns
- uint8_t
object_transfer_service_client_write_object_list_filter_1
uint8_t object_transfer_service_client_write_object_list_filter_1(ots_client_connection_t * connection, ots_filter_type_t filter_type, uint8_t data_length, const uint8_t * data);
Returns
- uint8_t
object_transfer_service_client_write_object_list_filter_2
uint8_t object_transfer_service_client_write_object_list_filter_2(ots_client_connection_t * connection, ots_filter_type_t filter_type, uint8_t data_length, const uint8_t * data);
Returns
- uint8_t
object_transfer_service_client_write_object_list_filter_3
uint8_t object_transfer_service_client_write_object_list_filter_3(ots_client_connection_t * connection, ots_filter_type_t filter_type, uint8_t data_length, const uint8_t * data);
Returns
- uint8_t
object_transfer_service_client_command_first
uint8_t object_transfer_service_client_command_first(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_command_last
uint8_t object_transfer_service_client_command_last(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_command_previous
uint8_t object_transfer_service_client_command_previous(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_command_next
uint8_t object_transfer_service_client_command_next(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_command_goto
uint8_t object_transfer_service_client_command_goto(ots_client_connection_t * connection, ots_object_id_t * object_id);
Returns
- uint8_t
object_transfer_service_client_command_order
uint8_t object_transfer_service_client_command_order(ots_client_connection_t * connection, olcp_list_sort_order_t order);
Returns
- uint8_t
object_transfer_service_client_command_request_number_of_objects
uint8_t object_transfer_service_client_command_request_number_of_objects(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_command_request_clear_marking
uint8_t object_transfer_service_client_command_request_clear_marking(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_open_object_channel
uint8_t object_transfer_service_client_open_object_channel(ots_client_connection_t * connection, uint8_t * cbm_receive_buffer, uint16_t cbm_receive_buffer_len);
Returns
- uint8_t
object_transfer_service_client_close_object_channel
uint8_t object_transfer_service_client_close_object_channel(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_read
uint8_t object_transfer_service_client_read(ots_client_connection_t * connection, uint32_t offset, uint32_t length);
Returns
- uint8_t
object_transfer_service_client_calculate_checksum
uint8_t object_transfer_service_client_calculate_checksum(ots_client_connection_t * connection, uint32_t offset, uint32_t length);
Returns
- uint8_t
object_transfer_service_client_write
uint8_t object_transfer_service_client_write(ots_client_connection_t * connection, bool truncated, uint32_t data_offset, uint8_t *data, uint16_t data_len);
Returns
- uint8_t
object_transfer_service_client_execute
uint8_t object_transfer_service_client_execute(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_abort
uint8_t object_transfer_service_client_abort(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_create_object
uint8_t object_transfer_service_client_create_object(ots_client_connection_t * connection, uint32_t object_size, ots_object_type_t type_uuid16);
Returns
- uint8_t
object_transfer_service_client_delete_object
uint8_t object_transfer_service_client_delete_object(ots_client_connection_t * connection);
Returns
- uint8_t
object_transfer_service_client_disconnect
uint8_t object_transfer_service_client_disconnect(ots_client_connection_t * connection);
Disconnect.
Parameters
- ots_cid
Returns
- uint8_t: status
object_transfer_service_client_deinit
void object_transfer_service_client_deinit(void);
De-initialize Object Transfer Service.