harmony(鸿蒙)OHOS::AVSession::AVSessionManager

  • 2022-12-22
  • 浏览 (593)

OHOS::AVSession::AVSessionManager

概述

实现会话管理器对外接口功能的类的实现。

Since: 9 Version: 1.0

汇总

Public 成员函数

名称 描述
CreateSession (const std::string &tag, int32_t type, const AppExecFwk::ElementName &elementName)=0 创建AVSession会话的接口方法。
GetAllSessionDescriptors (std::vector< AVSessionDescriptor > &descriptors)=0 获取AVSession全部的会话描述的接口方法。
GetActivatedSessionDescriptors (std::vector< AVSessionDescriptor > &activatedSessions)=0 获取AVSession全部处于活动状态的会话描述的接口方法。
GetSessionDescriptorsBySessionId (const std::string &sessionId, AVSessionDescriptor &descriptor)=0 通过会话ID获得会话描述的方法。
CreateController (const std::string &sessionId, std::shared_ptr< AVSessionController > &controller)=0 创建AVSession会话控制器的接口方法。
RegisterSessionListener (const std::shared_ptr< SessionListener > &listener)=0 注册AVSession会话监听器的接口方法。
RegisterServiceDeathCallback (const DeathCallback &callback)=0 注册AVSession服务器的死亡回调的接口方法。
UnregisterServiceDeathCallback ()=0 注销AVSession服务器的死亡回调的接口方法。
SendSystemAVKeyEvent (const MMI::KeyEvent &keyEvent)=0 发送系统按键事件的接口方法。
SendSystemControlCommand (const AVControlCommand &command)=0 发送系统控制命令的接口方法。
CastAudio (const SessionToken &token, const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 将媒体会话投射到远程设备或投射回本地设备。
CastAudioForAll (const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 将此设备的所有媒体会话投播到远程设备。

静态 Public 成员函数

名称 描述
GetInstance () 获取会话管理器实例。

成员函数说明

CastAudio()

virtual int32_t OHOS::AVSession::AVSessionManager::CastAudio (const SessionToken & token, const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors )

描述: 将媒体会话投射到远程设备或投射回本地设备。

参数:

名称 描述
token 需要投播的会话令牌。
descriptors 指定要转换的音频设备。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

CastAudioForAll()

virtual int32_t OHOS::AVSession::AVSessionManager::CastAudioForAll (const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors)

描述: 将此设备的所有媒体会话投播到远程设备。

参数:

名称 描述
descriptors 指定要转换的音频设备。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

CreateController()

virtual int32_t OHOS::AVSession::AVSessionManager::CreateController (const std::string & sessionId, std::shared_ptr< AVSessionController > & controller )

描述: 创建AVSession会话控制器的接口方法。

参数:

名称 描述
sessionId AVSession的会话ID。
controller 会话控制器实例，类型为AVSessionController。

返回:

返回成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

CreateSession()

virtual std::shared_ptr<AVSession> OHOS::AVSession::AVSessionManager::CreateSession (const std::string & tag, int32_t type, const AppExecFwk::ElementName & elementName )

描述: 创建AVSession会话的接口方法。

参数:

名称 描述
tag AVSession的会话标签，不可为空。
type AVSession的会话类型, 入参为AVSession的SESSION_TYPE_AUDIO，SESSION_TYPE_VIDEO。
elementName AVSession的会话名称AppExecFwk::ElementName。

返回:

返回已创建的会话对象的智能指针。

GetActivatedSessionDescriptors()

virtual int32_t OHOS::AVSession::AVSessionManager::GetActivatedSessionDescriptors (std::vector< AVSessionDescriptor > & activatedSessions)

描述: 获取AVSession全部处于活动状态的会话描述的接口方法。

参数:

名称 描述
activatedSessions 处于活动状态的会话描述，类型为AVSessionDescriptor。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

GetAllSessionDescriptors()

virtual int32_t OHOS::AVSession::AVSessionManager::GetAllSessionDescriptors (std::vector< AVSessionDescriptor > & descriptors)

描述: 获取AVSession全部的会话描述的接口方法。

参数:

名称 描述
descriptors AVSession的会话描述，类型为AVSessionDescriptor。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

GetInstance()

static AVSessionManager& OHOS::AVSession::AVSessionManager::GetInstance ()

描述: 获取会话管理器实例。

返回:

返回会话管理器实例。

GetSessionDescriptorsBySessionId()

virtual int32_t OHOS::AVSession::AVSessionManager::GetSessionDescriptorsBySessionId (const std::string & sessionId, AVSessionDescriptor & descriptor )

描述: 通过会话ID获得会话描述的方法。

参数:

名称 描述
sessionId AVSession的会话标签。
descriptor AVSession的会话描述，类型为AVSessionDescriptor。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

RegisterServiceDeathCallback()

virtual int32_t OHOS::AVSession::AVSessionManager::RegisterServiceDeathCallback (const DeathCallback & callback)

描述: 注册AVSession服务器的死亡回调的接口方法。

参数:

名称 描述
callback 死亡回调的方法，类型为DeathCallback。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

参见:

UnregisterServiceDeathCallback

RegisterSessionListener()

virtual int32_t OHOS::AVSession::AVSessionManager::RegisterSessionListener (const std::shared_ptr< SessionListener > & listener)

描述: 注册AVSession会话监听器的接口方法。

参数:

名称 描述
listener 会话监听器的智能指针，类型为SessionListener。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

SendSystemAVKeyEvent()

virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemAVKeyEvent (const MMI::KeyEvent & keyEvent)

描述: 发送系统按键事件的接口方法。

参数:

名称 描述
keyEvent 按键事件码，类型为MMI::KeyEvent。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

SendSystemControlCommand()

virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemControlCommand (const AVControlCommand & command)

描述: 发送系统控制命令的接口方法。

参数:

名称 描述
command 系统控制命令AVControlCommand。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

UnregisterServiceDeathCallback()

virtual int32_t OHOS::AVSession::AVSessionManager::UnregisterServiceDeathCallback ()

描述: 注销AVSession服务器的死亡回调的接口方法。

返回:

成功返回AVSESSION_SUCCESS；失败则返回对应错误码。

参见:

RegisterServiceDeathCallback

你可能感兴趣的鸿蒙文章

harmony(鸿蒙)Native API

harmony(鸿蒙)OHOS::AVSession::AVPlaybackState::Position

harmony(鸿蒙)AudioDecoder

harmony(鸿蒙)AudioEncoder

harmony(鸿蒙)CodecBase

harmony(鸿蒙)Core

harmony(鸿蒙)Drawing

harmony(鸿蒙)OHOS::AVSession::AVControllerCallback

harmony(鸿蒙)HiLog

harmony(鸿蒙)MindSpore

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/fa3c40cc63a84dbdbea8492316552248
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录