游戏多媒体引擎

产品动态

新手指引

产品简介

产品功能体验

购买指南

控制台指南

SDK 下载指引

快速接入语音

基础功能开发指南

进阶功能开发指南

客户端 API 2.x

服务端 API

常见问题

服务协议

联系我们

词汇表
文档捉虫大赛火热进行中，好礼多多> HOT
文档中心 > 游戏多媒体引擎 > 服务端 API > 数据结构

数据结构

最近更新时间：2023-03-21 01:38:47

我的收藏

本页目录：

AgeDetectTask

年龄语音识别子任务

被如下接口引用：CreateAgeDetectTask。

名称 类型 必选 描述
DataId String 是 数据唯一ID
Url String 是 数据文件的url，为 urlencode 编码,音频文件格式支持的类型：.wav、.m4a、.amr、.mp3、.aac、.wma、.ogg

AgeDetectTaskResult

年龄语音任务结果

被如下接口引用：DescribeAgeDetectTask。

名称 类型 描述
DataId String 数据唯一ID
Url String 数据文件的url
Status Integer 任务状态，0: 已创建，1:运行中，2:正常结束，3:异常结束，4:运行超时
Age Integer 任务结果：0: 成年，1:未成年，100:未知

AppStatisticsItem

应用用量统计数据

被如下接口引用：DescribeAppStatistics。

名称 类型 描述
RealtimeSpeechStatisticsItem RealTimeSpeechStatisticsItem 实时语音统计数据
注意：此字段可能返回 null，表示取不到有效值。
VoiceMessageStatisticsItem VoiceMessageStatisticsItem 语音消息统计数据
注意：此字段可能返回 null，表示取不到有效值。
VoiceFilterStatisticsItem VoiceFilterStatisticsItem 语音过滤统计数据
注意：此字段可能返回 null，表示取不到有效值。
Date Date 统计时间
AudioTextStatisticsItem AudioTextStatisticsItem 录音转文本用量统计数据
注意：此字段可能返回 null，表示取不到有效值。
StreamTextStatisticsItem StreamTextStatisticsItem 流式转文本用量数据
注意：此字段可能返回 null，表示取不到有效值。
OverseaTextStatisticsItem OverseaTextStatisticsItem 海外转文本用量数据
注意：此字段可能返回 null，表示取不到有效值。
RealtimeTextStatisticsItem RealtimeTextStatisticsItem 实时语音转文本用量数据
注意：此字段可能返回 null，表示取不到有效值。

ApplicationDataStatistics

应用统计数据

被如下接口引用：DescribeApplicationData。

名称 类型 描述
BizId Integer 应用ID
DauDataNum Integer Dau统计项数目
DauDataMainland Array of StatisticsItem 大陆地区Dau统计数据，单位人
DauDataOversea Array of StatisticsItem 海外地区Dau统计数据，单位人
DauDataSum Array of StatisticsItem 大陆和海外地区Dau统计数据汇总，单位人
DurationDataNum Integer 实时语音时长统计项数目
DurationDataMainland Array of StatisticsItem 大陆地区实时语音时长统计数据，单位分钟
DurationDataOversea Array of StatisticsItem 海外地区实时语音时长统计数据，单位分钟
DurationDataSum Array of StatisticsItem 大陆和海外地区实时语音时长统计数据汇总，单位分钟
PcuDataNum Integer Pcu统计项数目
PcuDataMainland Array of StatisticsItem 大陆地区Pcu统计数据，单位人
PcuDataOversea Array of StatisticsItem 海外地区Pcu统计数据，单位人
PcuDataSum Array of StatisticsItem 大陆和海外地区Pcu统计数据汇总，单位人

ApplicationList

获取应用列表返回

被如下接口引用：DescribeApplicationList。

名称 类型 描述
ServiceConf ServiceStatus 服务开关状态
BizId Integer 应用ID(AppID)
AppName String 应用名称
ProjectId Integer 项目ID，默认为0
AppStatus Integer 应用状态，返回0表示正常，1表示关闭，2表示欠费停服，3表示欠费回收
CreateTime Integer 创建时间，Unix时间戳格式
AppType Integer 应用类型，无需关注此数值

AudioTextStatisticsItem

录音转文本用量统计数据

被如下接口引用：DescribeAppStatistics。

名称 类型 描述
Data Float 统计值，单位：秒
注意：此字段可能返回 null，表示取不到有效值。

CreateAppResp

CreateApp的输出参数

被如下接口引用：CreateApp。

名称 类型 描述
BizId Integer 应用ID，由后台自动生成。
AppName String 应用名称，透传输入参数的AppName
ProjectId Integer 项目ID，透传输入的ProjectId
SecretKey String 应用密钥，GME SDK初始化时使用
CreateTime Integer 服务创建时间戳
RealtimeSpeechConf RealtimeSpeechConf 实时语音服务配置数据
VoiceMessageConf VoiceMessageConf 语音消息及转文本服务配置数据
VoiceFilterConf VoiceFilterConf 语音分析服务配置数据

CustomizationConfigs

语音消息转文本热句模型配置

被如下接口引用：GetCustomizationList。

名称 类型 必选 描述
BizId Integer 是 应用 ID，登录控制台创建应用得到的AppID
ModelId String 是 模型ID
ModelState Integer 是 模型状态，-1下线状态，1上线状态, 0训练中, -2训练失败, 3上线中, 4下线中
ModelName String 否 模型名称
TextUrl String 否 文本文件的下载地址，服务会从该地址下载文件，目前仅支持腾讯云cos
UpdateTime Integer 否 更新时间，11位时间戳

DeleteResult

剔除房间操作结果

被如下接口引用：DeleteRoomMember。

名称 类型 描述
Code Integer 错误码，0-剔除成功 其他-剔除失败
ErrorMsg String 错误描述

DescribeAppStatisticsResp

获取应用用量统计数据输出参数

被如下接口引用：DescribeAppStatistics。

名称 类型 描述
AppStatistics Array of AppStatisticsItem 应用用量统计数据

DescribeScanResult

语音检测结果返回

被如下接口引用：DescribeScanResultList。

名称 类型 描述
Code Integer 业务返回码
DataId String 数据唯一 ID
ScanFinishTime Integer 检测完成的时间戳
HitFlag Boolean 是否违规
Live Boolean 是否为流
Msg String 业务返回描述
注意：此字段可能返回 null，表示取不到有效值。
ScanPiece Array of ScanPiece 检测结果，Code 为 0 时返回
注意：此字段可能返回 null，表示取不到有效值。
ScanStartTime Integer 提交检测的时间戳
Scenes Array of String 语音检测场景，对应请求时的 Scene
TaskId String 语音检测任务 ID，由后台分配
Url String 文件或接流地址
Status String 检测任务执行结果状态，分别为：
  • Start: 任务开始
  • Success: 成功结束
  • Error: 异常
    		•
    BizId Integer 提交检测的应用 ID

    Filter

    查找过滤

    被如下接口引用：DescribeApplicationList。

    名称 类型 必选 描述
    Name String 否 要过滤的字段名, 比如"AppName"
    Values Array of String 否 多个关键字

    InOutTimeInfo

    房间内的事件

    被如下接口引用：DescribeUserInAndOutTime。

    名称 类型 描述
    StartTime Integer 进入房间时间
    EndTime Integer 退出房间时间

    ModifyAppStatusResp

    ModifyAppStatus接口输出参数

    被如下接口引用：ModifyAppStatus。

    名称 类型 描述
    BizId Integer GME应用ID
    Status String 应用状态，取值：open/close

    OverseaTextStatisticsItem

    海外转文本用量数据

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    Data Float 统计值，单位：秒
    注意：此字段可能返回 null，表示取不到有效值。

    RealTimeSpeechStatisticsItem

    实时语音用量统计数据

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    MainLandDau Integer 大陆地区DAU
    MainLandPcu Integer 大陆地区PCU
    MainLandDuration Integer 大陆地区总使用时长，单位为min
    OverseaDau Integer 海外地区DAU
    OverseaPcu Integer 海外地区PCU
    OverseaDuration Integer 海外地区总使用时长，单位为min

    RealtimeSpeechConf

    实时语音配置数据

    被如下接口引用：CreateApp。

    名称 类型 必选 描述
    Status String 否 实时语音服务开关，取值：open/close
    Quality String 否 实时语音音质类型，取值：high-高音质

    RealtimeTextStatisticsItem

    实时语音转文本用量数据

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    Data Float 统计值，单位：秒
    注意：此字段可能返回 null，表示取不到有效值。

    RecordInfo

    房间内录制信息信息
    注意：此字段可能返回 null，表示取不到有效值。

    被如下接口引用：DescribeRecordInfo。

    名称 类型 描述
    UserId String 用户ID（当混流模式时，取值为0）。
    FileName String 录制文件名。
    RecordBeginTime Integer 录制开始时间（unix时间戳如：1234567868）。
    RecordStatus Integer 录制状态：2代表正在录制 10代表等待转码 11代表正在转码 12正在上传 13代表上传完成 14代表通知用户完成。

    RoomUser

    房间内用户信息

    被如下接口引用：DescribeRoomInfo。

    名称 类型 描述
    RoomId Integer 房间id
    Uins Array of Integer 房间里用户uin列表
    注意：此字段可能返回 null，表示取不到有效值。
    StrRoomId String 字符串房间id
    注意：此字段可能返回 null，表示取不到有效值。
    StrUins Array of String 房间里用户字符串uin列表
    注意：此字段可能返回 null，表示取不到有效值。

    ScanDetail

    语音检测详情

    被如下接口引用：DescribeScanResultList。

    名称 类型 描述
    Label String 违规场景，参照Label定义
    Rate String 该场景下概率[0.00,100.00],分值越大违规概率越高
    KeyWord String 违规关键字
    StartTime Integer 关键字在音频的开始时间，从0开始的偏移量，单位为毫秒
    EndTime Integer 关键字在音频的结束时间，从0开始的偏移量,，单位为毫秒

    ScanPiece

    语音检测结果，Code 为 0 时返回

    被如下接口引用：DescribeScanResultList。

    名称 类型 描述
    DumpUrl String 流检测时返回，音频转存地址，保留30min
    注意：此字段可能返回 null，表示取不到有效值。
    HitFlag Boolean 是否违规
    MainType String 违规主要类型
    注意：此字段可能返回 null，表示取不到有效值。
    ScanDetail Array of ScanDetail 语音检测详情
    RoomId String gme实时语音房间ID，透传任务传入时的RoomId
    注意：此字段可能返回 null，表示取不到有效值。
    OpenId String gme实时语音用户ID，透传任务传入时的OpenId
    注意：此字段可能返回 null，表示取不到有效值。
    Info String 备注
    注意：此字段可能返回 null，表示取不到有效值。
    Offset Integer 流检测时分片在流中的偏移时间，单位毫秒
    注意：此字段可能返回 null，表示取不到有效值。
    Duration Integer 流检测时分片时长
    注意：此字段可能返回 null，表示取不到有效值。
    PieceStartTime Integer 分片开始检测时间
    注意：此字段可能返回 null，表示取不到有效值。

    ScanVoiceResult

    语音检测返回结果

    被如下接口引用：ScanVoice。

    名称 类型 描述
    DataId String 数据ID
    TaskId String 任务ID

    ServiceStatus

    服务开关状态

    被如下接口引用：DescribeApplicationList。

    名称 类型 描述
    RealTimeSpeech StatusInfo 实时语音服务开关状态
    注意：此字段可能返回 null，表示取不到有效值。
    VoiceMessage StatusInfo 语音消息服务开关状态
    注意：此字段可能返回 null，表示取不到有效值。
    Porn StatusInfo 语音内容安全服务开关状态
    注意：此字段可能返回 null，表示取不到有效值。
    Live StatusInfo 语音录制服务开关状态
    注意：此字段可能返回 null，表示取不到有效值。
    RealTimeAsr StatusInfo 语音转文本服务开关状态
    注意：此字段可能返回 null，表示取不到有效值。

    StatisticsItem

    用量数据单元

    被如下接口引用：DescribeApplicationData。

    名称 类型 描述
    StatDate Date 日期，格式为年-月-日，如2018-07-13
    Data Integer 统计值

    StatusInfo

    服务开关状态

    被如下接口引用：DescribeApplicationList。

    名称 类型 描述
    Status Integer 服务开关状态， 0-正常，1-关闭

    StreamTextStatisticsItem

    流式转文本用量数据

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    Data Float 统计值，单位：秒
    注意：此字段可能返回 null，表示取不到有效值。

    SubscribeRecordUserIds

    指定订阅流白名单或者黑名单。

    被如下接口引用：DescribeTaskInfo, ModifyRecordInfo, StartRecord。

    名称 类型 必选 描述
    UnSubscribeUserIds Array of String 否 订阅音频流黑名单，指定不订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表不订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。
    注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数
    SubscribeUserIds Array of String 否 订阅音频流白名单，指定订阅哪几个UserId的音频流，例如["1", "2", "3"], 代表订阅UserId 1，2，3的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过20。
    注意：只能同时设置UnSubscribeAudioUserIds、SubscribeAudioUserIds 其中1个参数。

    Tag

    标签列表

    被如下接口引用：CreateApp, DescribeApplicationList。

    名称 类型 必选 描述
    TagKey String 否 标签键
    注意：此字段可能返回 null，表示取不到有效值。
    TagValue String 否 标签值
    注意：此字段可能返回 null，表示取不到有效值。

    Task

    语音检测任务列表

    被如下接口引用：ScanVoice。

    名称 类型 必选 描述
    DataId String 是 数据的唯一ID
    Url String 是 数据文件的url，为 urlencode 编码，流式则为拉流地址
    RoomId String 否 gme实时语音房间ID，通过gme实时语音进行语音分析时输入
    OpenId String 否 gme实时语音用户ID，通过gme实时语音进行语音分析时输入

    UserMicStatus

    用户麦克风状态

    被如下接口引用：ModifyUserMicStatus。

    名称 类型 必选 描述
    EnableMic Integer 是 开麦状态。1表示关闭麦克风，2表示打开麦克风。
    Uid Integer 否 客户端用于标识用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。）
    StrUid String 否 客户端用于标识字符串型用户的Openid。（Uid、StrUid必须填一个，优先处理StrUid。）

    VoiceFilterConf

    语音过滤服务配置数据

    被如下接口引用：CreateApp。

    名称 类型 必选 描述
    Status String 否 语音过滤服务开关，取值：open/close

    VoiceFilterStatisticsItem

    语音过滤用量统计数据

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    Duration Integer 语音过滤总时长，单位为min

    VoiceMessageConf

    离线语音服务配置数据

    被如下接口引用：CreateApp。

    名称 类型 必选 描述
    Status String 否 离线语音服务开关，取值：open/close
    Language String 否 离线语音支持语种，取值： all-全部，cnen-中英文。默认为中英文

    VoiceMessageStatisticsItem

    语音消息用量统计信息

    被如下接口引用：DescribeAppStatistics。

    名称 类型 描述
    Dau Integer 离线语音DAU
    目录
    中国站