native_deviceinfo.h

概述

提供播控设备信息的定义。

引用文件： <multimedia/av_session/native_deviceinfo.h>

库： libohavsession.so

系统能力： SystemCapability.Multimedia.AVSession.Core

起始版本： 23

相关模块： OHAVSession

汇总

结构体

名称	typedef关键字	描述
AVSession_OutputDeviceInfo	-	目标设备信息的定义。
AVSession_DeviceInfo	AVSession_DeviceInfo	设备信息的声明。该实例用于获取更多的设备信息及其详细属性。

函数

名称	描述
AVSession_ErrCode OH_DeviceInfo_GetAVCastCategory(AVSession_DeviceInfo deviceInfo, AVSession_AVCastCategory aVCastCategory)	获取目标设备的Cast类别。
AVSession_ErrCode OH_DeviceInfo_GetDeviceId(AVSession_DeviceInfo deviceInfo, char *deviceId)	获取目标设备的设备ID。
AVSession_ErrCode OH_DeviceInfo_GetDeviceName(AVSession_DeviceInfo deviceInfo, char *deviceName)	获取目标设备的设备名称。
AVSession_ErrCode OH_DeviceInfo_GetDeviceType(AVSession_DeviceInfo deviceInfo, AVSession_DeviceType deviceType)	获取目标设备的设备类型。
AVSession_ErrCode OH_DeviceInfo_GetSupportedProtocols(AVSession_DeviceInfo deviceInfo, uint32_t deviceProtocolType)	获取目标设备支持的协议。

函数说明

OH_DeviceInfo_GetAVCastCategory()

AVSession_ErrCode OH_DeviceInfo_GetAVCastCategory(AVSession_DeviceInfo *deviceInfo, AVSession_AVCastCategory *aVCastCategory)

描述

获取目标设备的Cast类别。

起始版本： 23

参数：

参数项	描述
AVSession_DeviceInfo *deviceInfo	表示设备信息实例指针。
AVSession_AVCastCategory *aVCastCategory	返回aVCastCategory值的指针变量。

返回：

类型	说明
AVSession_ErrCode	AV_SESSION_ERR_SUCCESS：函数执行成功。 AV_SESSION_ERR_INVALID_PARAMETER： 1. 参数deviceInfo为nullptr。 2. 参数aVCastCategory为nullptr。

OH_DeviceInfo_GetDeviceId()

AVSession_ErrCode OH_DeviceInfo_GetDeviceId(AVSession_DeviceInfo *deviceInfo, char **deviceId)

描述

获取目标设备的设备ID。

起始版本： 23

参数：

参数项	描述
AVSession_DeviceInfo *deviceInfo	表示设备信息实例指针。
char **deviceId	返回设备ID值的指针变量。

返回：

类型	说明
AVSession_ErrCode	AV_SESSION_ERR_SUCCESS：函数执行成功。 AV_SESSION_ERR_INVALID_PARAMETER： 1. 参数deviceInfo为nullptr。 2. 参数deviceId为nullptr。

OH_DeviceInfo_GetDeviceName()

AVSession_ErrCode OH_DeviceInfo_GetDeviceName(AVSession_DeviceInfo *deviceInfo, char **deviceName)

描述

获取目标设备的设备名称。

起始版本： 23

参数：

参数项	描述
AVSession_DeviceInfo *deviceInfo	表示设备信息实例指针。
char **deviceName	返回设备名称的指针变量。

返回：

类型	说明
AVSession_ErrCode	AV_SESSION_ERR_SUCCESS：函数执行成功。 AV_SESSION_ERR_INVALID_PARAMETER： 1. 参数deviceInfo为nullptr。 2. 参数deviceName为nullptr。

OH_DeviceInfo_GetDeviceType()

AVSession_ErrCode OH_DeviceInfo_GetDeviceType(AVSession_DeviceInfo *deviceInfo, AVSession_DeviceType *deviceType)

描述

获取目标设备的设备类型。

起始版本： 23

参数：

参数项	描述
AVSession_DeviceInfo *deviceInfo	表示设备信息实例指针。
AVSession_DeviceType *deviceType	返回设备类型的指针变量。

返回：

类型	说明
AVSession_ErrCode	AV_SESSION_ERR_SUCCESS：函数执行成功。 AV_SESSION_ERR_INVALID_PARAMETER： 1. 参数deviceInfo为nullptr。 2. 参数deviceType为nullptr。

OH_DeviceInfo_GetSupportedProtocols()

AVSession_ErrCode OH_DeviceInfo_GetSupportedProtocols(AVSession_DeviceInfo *deviceInfo, uint32_t *deviceProtocolType)

描述

获取目标设备支持的协议。

起始版本： 23

参数：

参数项	描述
AVSession_DeviceInfo *deviceInfo	表示设备信息实例指针。
uint32_t *deviceProtocolType	返回设备支持协议的指针变量。

返回：

类型	说明
AVSession_ErrCode	AV_SESSION_ERR_SUCCESS：函数执行成功。 AV_SESSION_ERR_INVALID_PARAMETER： 1. 参数deviceInfo为nullptr。 2. 参数deviceProtocolType为nullptr。