openharmony 鸿蒙 capi-native-midi-h

2026-08-25 浏览 (1)

native_midi.h

概述

声明MIDI相关的接口。MIDI是一种用于电子乐器、计算机和其他设备之间通信的技术标准。
该文件中的接口用于MIDI设备管理、MIDI消息发送和接收、设备状态监控等。
使用OHMIDI连接MIDI设备的典型流程如下：

  1. 创建客户端：初始化MIDI客户端上下文，并注册设备热插拔回调及服务异常回调。
  2. 发现设备与端口：获取当前连接的设备列表，并查询设备的端口能力。
  3. 打开设备：建立设备连接会话。
  4. 打开端口：根据端口方向（输入/输出）分别打开端口。
  5. 数据交互：
    • 接收：通过回调函数接收UMP（Universal MIDI Packet 通用MIDI数据包）格式的MIDI数据。
    • 发送：构建UMP（Universal MIDI Packet 通用MIDI数据包）数据包并通过输出端口发送。
  6. 释放资源：使用完毕后关闭端口、设备并销毁客户端。

引用文件： <midi/native_midi.h>

库： libohmidi.so

系统能力： SystemCapability.Multimedia.Audio.MIDI

起始版本： 24

相关模块： OHMIDI

汇总

函数

名称描述
OH_MIDIStatusCode OH_MIDIClient_Create(OH_MIDIClient **client, OH_MIDICallbacks callbacks, void *userData)创建MIDI客户端实例。客户端是使用MIDI服务的入口，所有MIDI操作都需要先创建客户端。
MIDI是对低延迟有严格要求的系统服务。为确保实时性能和系统稳定性，服务强制执行以下限制：
1. 系统级限制：全局允许的活动MIDI客户端最大数量为8个。
2. 每应用限制：每个应用UID允许的MIDI客户端最大数量为2个。建议应用在整个生命周期内维护单个MIDI客户端实例，用于管理多个设备/端口。
在不再需要MIDI功能时，使用OH_MIDIClient_Destroy释放客户端及所有关联资源。
OH_MIDIStatusCode OH_MIDIClient_Destroy(OH_MIDIClient *client)销毁MIDI客户端并释放资源。
OH_MIDIStatusCode OH_MIDIClient_GetDeviceCount(const OH_MIDIClient *client, size_t *count)获取连接的MIDI设备数量。此函数用于确定存储设备信息所需的缓冲区大小。
如果应用未获得蓝牙权限（ohos.permission.ACCESS_BLUETOOTH），蓝牙MIDI设备将不会包含在设备数量中。
OH_MIDIStatusCode OH_MIDIClient_GetDeviceInfos(const OH_MIDIClient *client, OH_MIDIDeviceInformation *infos, size_t capacity, size_t *actualDeviceCount)获取连接的MIDI设备信息。将设备信息写入infos参数指定的缓冲区。缓冲区大小应基于OH_MIDIClient_GetDeviceCount返回的数量进行分配。
如果应用未获得蓝牙权限（ohos.permission.ACCESS_BLUETOOTH），蓝牙MIDI设备将不会包含在返回的设备信息中。
OH_MIDIStatusCode OH_MIDIClient_OpenDevice(OH_MIDIClient *client, int64_t deviceId, OH_MIDIDevice **device)打开指定ID的MIDI设备。
OH_MIDIStatusCode OH_MIDIClient_OpenBLEDevice(OH_MIDIClient *client, const char *deviceAddr, OH_MIDIClient_OnDeviceOpened callback, void *userData)异步打开蓝牙低功耗（BLE）MIDI设备。此函数为异步操作，调用后立即返回状态码（表示请求是否成功发送），实际连接结果（成功或失败）将在BLE连接过程完成后通过提供的回调异步传递。
OH_MIDIStatusCode OH_MIDIClient_CloseDevice(OH_MIDIClient *client, OH_MIDIDevice *device)关闭MIDI设备。
OH_MIDIStatusCode OH_MIDIClient_GetPortCount(const OH_MIDIClient *client, int64_t deviceId, size_t *count)获取指定MIDI设备的端口数量。此函数用于确定存储端口信息所需的缓冲区大小。
OH_MIDIStatusCode OH_MIDIClient_GetPortInfos(const OH_MIDIClient *client, int64_t deviceId, OH_MIDIPortInformation *infos, size_t capacity, size_t *actualPortCount)获取指定MIDI设备的端口信息。将端口信息写入由调用者分配的缓冲区。
OH_MIDIStatusCode OH_MIDIDevice_OpenInputPort(OH_MIDIDevice *device, OH_MIDIPortDescriptor descriptor, OH_MIDIDevice_OnReceived callback, void *userData)打开MIDI输入端口（接收数据）。注册回调函数以接收MIDI数据流。
OH_MIDIStatusCode OH_MIDIDevice_OpenOutputPort(OH_MIDIDevice *device, OH_MIDIPortDescriptor descriptor)打开MIDI输出端口（发送数据）。
OH_MIDIStatusCode OH_MIDIDevice_CloseInputPort(OH_MIDIDevice *device, uint32_t portIndex)关闭MIDI输入端口。
OH_MIDIStatusCode OH_MIDIDevice_CloseOutputPort(OH_MIDIDevice *device, uint32_t portIndex)关闭MIDI输出端口。
OH_MIDIStatusCode OH_MIDIDevice_Send(OH_MIDIDevice *device, uint32_t portIndex, const OH_MIDIEvent *events, uint32_t eventCount, uint32_t *eventsWritten)批量发送MIDI消息（非阻塞模式，每条消息具有原子性）。
OH_MIDIStatusCode OH_MIDIDevice_SendSysEx(OH_MIDIDevice *device, uint32_t portIndex, const uint8_t *data, uint32_t byteSize)发送超过标准MIDI消息长度的SysEx（System Exclusive，系统专用）消息，自动处理拆包和阻塞等待。这是一个实用函数，适用于将SysEx作为原始字节流（MIDI 1.0风格，F0...F7）处理的应用。
同时适用于OH_MIDI_PROTOCOL_1_0和OH_MIDI_PROTOCOL_2_0会话。
操作系统MIDI服务会自动将数据转换为设备端口所需的格式。
OH_MIDIStatusCode OH_MIDIDevice_FlushOutputPort(OH_MIDIDevice *device, uint32_t portIndex)清空输出缓冲区中的待发送消息。立即丢弃指定端口输出缓冲区中等待的所有MIDI事件，包括用于未来时间戳的事件。

函数说明

OH_MIDIClient_Create()

OH_MIDIStatusCode OH_MIDIClient_Create(OH_MIDIClient **client, OH_MIDICallbacks callbacks, void *userData)

描述

创建MIDI客户端实例。客户端是使用MIDI服务的入口，所有MIDI操作都需要先创建客户端。
MIDI是对低延迟有严格要求的系统服务。为确保实时性能和系统稳定性，服务强制执行以下限制：
1. 系统级限制：全局允许的活动MIDI客户端最大数量为8个。
2. 每应用限制：每个应用UID允许的MIDI客户端最大数量为2个。建议应用在整个生命周期内维护单个MIDI客户端实例，用于管理多个设备/端口。
在不再需要MIDI功能时，使用OH_MIDIClient_Destroy释放客户端及所有关联资源。

起始版本： 24

参数：

参数项描述
OH_MIDIClient **client指向用于接收新客户端句柄的指针。
OH_MIDICallbacks callbacks用于系统事件的回调结构体。
void *userData传递给回调函数的用户自定义数据指针。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数client为nullptr。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。
OH_MIDI_STATUS_TOO_MANY_CLIENTS：因资源限制MIDI客户端创建失败。当调用应用超出其每UID配额或系统全局客户端数量已达上限时发生。

OH_MIDIClient_Destroy()

OH_MIDIStatusCode OH_MIDIClient_Destroy(OH_MIDIClient *client)

描述

销毁MIDI客户端并释放资源。

说明：

在不再需要MIDI功能时（例如应用退出或MIDI模块停用时）调用此函数销毁客户端。销毁客户端时会自动关闭所有通过此客户端打开的设备和端口（安全回收机制），无需手动逐一关闭。建议在销毁前按逆序手动关闭资源以保证代码逻辑清晰（端口->设备->客户端），但这非强制要求。

起始版本： 24

参数：

参数项描述
OH_MIDIClient *client目标客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄为NULL或无效。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIClient_GetDeviceCount()

OH_MIDIStatusCode OH_MIDIClient_GetDeviceCount(const OH_MIDIClient *client, size_t *count)

描述

获取连接的MIDI设备数量。此函数用于确定存储设备信息所需的缓冲区大小。
如果应用未获得蓝牙权限（ohos.permission.ACCESS_BLUETOOTH），蓝牙MIDI设备将不会包含在设备数量中。

起始版本： 24

参数：

参数项描述
const OH_MIDIClient *clientMIDI客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
size_t *count输出参数，用于接收设备数量。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数count为nullptr。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIClient_GetDeviceInfos()

OH_MIDIStatusCode OH_MIDIClient_GetDeviceInfos(const OH_MIDIClient *client, OH_MIDIDeviceInformation *infos, size_t capacity, size_t *actualDeviceCount)

描述

获取连接的MIDI设备信息。将设备信息写入infos参数指定的缓冲区。缓冲区大小应基于OH_MIDIClient_GetDeviceCount返回的数量进行分配。
如果应用未获得蓝牙权限（ohos.permission.ACCESS_BLUETOOTH），蓝牙MIDI设备将不会包含在返回的设备信息中。

说明：

当实际连接的设备数量大于输入参数'infos'数组的容量时，输出'infos'数组将仅包含部分设备信息，输出'actualDeviceCount'将等于'capacity'，函数返回OH_MIDI_STATUS_OK。当实际数量小于或等于'capacity'时，所有可用设备信息将填入'infos'，输出'actualDeviceCount'反映实际设备数量。

起始版本： 24

参数：

参数项描述
const OH_MIDIClient *clientMIDI客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
OH_MIDIDeviceInformation *infos用户分配的该缓冲区，用于存储设备信息。
size_t capacity缓冲区可容纳的最大元素数量。
size_t *actualDeviceCount输出参数，用于接收实际写入的设备数量。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数infos或actualDeviceCount为nullptr。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIClient_OpenDevice()

OH_MIDIStatusCode OH_MIDIClient_OpenDevice(OH_MIDIClient *client, int64_t deviceId, OH_MIDIDevice **device)

描述

打开指定ID的MIDI设备。

说明：

使用OH_MIDIClient_CloseDevice释放设备资源。

起始版本： 24

参数：

参数项描述
OH_MIDIClient *client目标客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
int64_t deviceId设备的唯一标识符，由OH_MIDIClient_GetDeviceInfos获取。
OH_MIDIDevice **device指向用于接收设备句柄的指针，由系统分配。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_DEVICE_ALREADY_OPEN：设备已被当前客户端打开。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数device为nullptr，或deviceId不存在。
OH_MIDI_STATUS_TOO_MANY_OPEN_DEVICES：客户端已达到最大打开设备数量限制。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIClient_OpenBLEDevice()

OH_MIDIStatusCode OH_MIDIClient_OpenBLEDevice(OH_MIDIClient *client, const char *deviceAddr, OH_MIDIClient_OnDeviceOpened callback, void *userData)

描述

异步打开蓝牙低功耗（BLE）MIDI设备。此函数为异步操作，调用后立即返回状态码（表示请求是否成功发送），实际连接结果（成功或失败）将在BLE连接过程完成后通过提供的回调异步传递。

说明：

如果蓝牙权限被拒绝，OH_MIDIClient_OnDeviceOpened回调将以opened参数为false、device参数为null被调用。应用应检查opened参数后再尝试使用设备句柄。

需要权限： ohos.permission.ACCESS_BLUETOOTH

起始版本： 24

参数：

参数项描述
OH_MIDIClient *client目标客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
const char *deviceAddrBLE设备的MAC地址（例如："AA:BB:CC:DD:EE:FF"）。
OH_MIDIClient_OnDeviceOpened callback连接过程完成时要调用的回调函数。
void *userData传递给回调的用户自定义数据指针。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：连接请求已成功分发。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_DEVICE_ALREADY_OPEN：设备已被当前客户端打开。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数deviceAddr或callback为nullptr。
OH_MIDI_STATUS_PERMISSION_DENIED：权限被拒绝。应用未声明或未获得所需权限。
OH_MIDI_STATUS_TOO_MANY_OPEN_DEVICES：客户端已达到最大打开设备数量限制。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：服务无法访问。

OH_MIDIClient_CloseDevice()

OH_MIDIStatusCode OH_MIDIClient_CloseDevice(OH_MIDIClient *client, OH_MIDIDevice *device)

描述

关闭MIDI设备。

说明：

关闭设备时会同时关闭该设备上所有已打开的端口。该功能与OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice配对使用。

起始版本： 24

参数：

参数项描述
OH_MIDIClient *client目标客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。

OH_MIDIClient_GetPortCount()

OH_MIDIStatusCode OH_MIDIClient_GetPortCount(const OH_MIDIClient *client, int64_t deviceId, size_t *count)

描述

获取指定MIDI设备的端口数量。此函数用于确定存储端口信息所需的缓冲区大小。

起始版本： 24

参数：

参数项描述
const OH_MIDIClient *clientMIDI客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
int64_t deviceId目标设备ID。
size_t *count输出参数，用于接收端口数量。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数count为nullptr，或deviceId无效。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIClient_GetPortInfos()

OH_MIDIStatusCode OH_MIDIClient_GetPortInfos(const OH_MIDIClient *client, int64_t deviceId, OH_MIDIPortInformation *infos, size_t capacity, size_t *actualPortCount)

描述

获取指定MIDI设备的端口信息。将端口信息写入由调用者分配的缓冲区。

说明：

当实际端口数量大于输入参数'infos'数组的容量时，输出'infos'数组将仅包含部分端口信息，输出'actualPortCount'将等于'capacity'，函数返回OH_MIDI_STATUS_OK。当实际数量小于或等于'capacity'时，所有可用端口信息将填入'infos'，输出'actualPortCount'反映实际端口数量。

起始版本： 24

参数：

参数项描述
const OH_MIDIClient *clientMIDI客户端句柄。传入的client指针必须为OH_MIDIClient_Create创建的实例。
int64_t deviceId目标设备ID。
OH_MIDIPortInformation *infos用户分配的缓冲区，用于存储端口信息。
size_t capacityinfos缓冲区可容纳的最大元素数量。
size_t *actualPortCount输出参数，用于接收实际写入的端口数量。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_CLIENT：客户端句柄无效。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数infos或actualPortCount为nullptr，或deviceId无效。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_OpenInputPort()

OH_MIDIStatusCode OH_MIDIDevice_OpenInputPort(OH_MIDIDevice *device, OH_MIDIPortDescriptor descriptor, OH_MIDIDevice_OnReceived callback, void *userData)

描述

打开MIDI输入端口（接收数据）。注册回调函数以接收MIDI数据流。

说明：

使用OH_MIDIDevice_CloseInputPort关闭输入端口。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
OH_MIDIPortDescriptor descriptor端口索引和协议配置。
OH_MIDIDevice_OnReceived callback有数据可用时调用的回调函数。
void *userData传递给回调的用户自定义数据指针。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效或不是输入端口。
OH_MIDI_STATUS_PORT_ALREADY_OPEN：端口已被此客户端打开。
OH_MIDI_STATUS_TOO_MANY_OPEN_PORTS：已达到最大打开端口数量限制。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数callback为nullptr。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_OpenOutputPort()

OH_MIDIStatusCode OH_MIDIDevice_OpenOutputPort(OH_MIDIDevice *device, OH_MIDIPortDescriptor descriptor)

描述

打开MIDI输出端口（发送数据）。

说明：

使用OH_MIDIDevice_CloseOutputPort关闭输出端口。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
OH_MIDIPortDescriptor descriptor端口索引和协议配置。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效或不是输出端口。
OH_MIDI_STATUS_PORT_ALREADY_OPEN：端口已被此客户端打开。
OH_MIDI_STATUS_TOO_MANY_OPEN_PORTS：已达到最大打开端口数量限制。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_CloseInputPort()

OH_MIDIStatusCode OH_MIDIDevice_CloseInputPort(OH_MIDIDevice *device, uint32_t portIndex)

描述

关闭MIDI输入端口。

说明：

与OH_MIDIDevice_OpenInputPort配对使用。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
uint32_t portIndex要关闭的输入端口索引。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效，或未打开。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_CloseOutputPort()

OH_MIDIStatusCode OH_MIDIDevice_CloseOutputPort(OH_MIDIDevice *device, uint32_t portIndex)

描述

关闭MIDI输出端口。

说明：

与OH_MIDIDevice_OpenOutputPort配对使用。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
uint32_t portIndex要关闭的输出端口索引。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效，或不是打开的输出端口。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_Send()

OH_MIDIStatusCode OH_MIDIDevice_Send(OH_MIDIDevice *device, uint32_t portIndex, const OH_MIDIEvent *events, uint32_t eventCount, uint32_t *eventsWritten)

描述

批量发送MIDI消息（非阻塞模式，每条消息具有原子性）。

说明：

将MIDI事件数组写入共享内存缓冲区。

  • 单条消息原子性：每条事件作为不可分割的单元处理，不会出现消息被截断的情况。
  • 批量操作非原子性：整个数组不一定全部写入成功。如果缓冲区空间不足，已成功写入的事件不会被回滚。函数返回OH_MIDI_STATUS_WOULD_BLOCK，并通过eventsWritten参数返回已成功写入的事件数量，开发者可据此从断点处继续发送剩余事件。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
uint32_t portIndex目标端口索引。
const OH_MIDIEvent *events指向要发送的事件数组的指针，内存空间需要由开发者分配。
uint32_t eventCount数组中的事件数量。
uint32_t *eventsWritten输出参数，返回成功发送的事件数量。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：所有数据均已成功处理并写入。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效，或未打开。
OH_MIDI_STATUS_WOULD_BLOCK：缓冲区已满（检查eventsWritten）。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数无效。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

OH_MIDIDevice_SendSysEx()

OH_MIDIStatusCode OH_MIDIDevice_SendSysEx(OH_MIDIDevice *device, uint32_t portIndex, const uint8_t *data, uint32_t byteSize)

描述

发送超过标准MIDI消息长度的SysEx（System Exclusive，系统专用）消息，自动处理拆包和阻塞等待。这是一个实用函数，适用于将SysEx作为原始字节流（MIDI 1.0风格，F0...F7）处理的应用。
同时适用于OH_MIDI_PROTOCOL_1_0和OH_MIDI_PROTOCOL_2_0会话。
操作系统MIDI服务会自动将数据转换为设备端口所需的格式。

说明：

此函数为阻塞调用，执行循环写入，当缓冲区填满时将阻塞并重试，直至写入完整。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
uint32_t portIndex目标端口索引。
const uint8_t *data指向要发送的字节数据流的指针，内存空间需要由开发者分配。
uint32_t byteSize数据的字节大小。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：所有数据均已成功处理并写入。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效，或未打开。
OH_MIDI_STATUS_TIMEOUT：无法在合理时间内完成，可使用OH_MIDIDevice_FlushOutputPort重置。
OH_MIDI_STATUS_GENERIC_INVALID_ARGUMENT：参数无效。

OH_MIDIDevice_FlushOutputPort()

OH_MIDIStatusCode OH_MIDIDevice_FlushOutputPort(OH_MIDIDevice *device, uint32_t portIndex)

描述

清空输出缓冲区中的待发送消息。立即丢弃指定端口输出缓冲区中等待的所有MIDI事件，包括用于未来时间戳的事件。

说明：

此操作不发送"All Notes Off"消息，仅清空队列。

起始版本： 24

参数：

参数项描述
OH_MIDIDevice *device目标设备句柄。传入的device指针必须为OH_MIDIClient_OpenDevice或OH_MIDIClient_OpenBLEDevice返回的实例。
uint32_t portIndex目标端口索引。

返回：

类型说明
OH_MIDIStatusCodeOH_MIDI_STATUS_OK：操作成功。
OH_MIDI_STATUS_INVALID_DEVICE_HANDLE：设备句柄无效。
OH_MIDI_STATUS_INVALID_PORT：端口索引无效或不是输出端口。
OH_MIDI_STATUS_GENERIC_IPC_FAILURE：连接系统服务失败。

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-native-audiostreambuilder-h

openharmony 鸿蒙 capi-ohaudiosuite

openharmony 鸿蒙 js-apis-inner-multimedia-systemSoundPlayer

openharmony 鸿蒙 arkts-apis-audio-i

openharmony 鸿蒙 capi-ohaudio

openharmony 鸿蒙 capi-ohmidi

openharmony 鸿蒙 arkts-apis-audio-AudioManager

openharmony 鸿蒙 capi-ohaudiosuite-oh-audiosuite-spacerenderpositionparams

openharmony 鸿蒙 capi-ohaudio-oh-audiostreaminfo

openharmony 鸿蒙 capi-ohmidi-oh-midideviceinformation

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/5HZA5Fll