跳到主要内容
版本:4.0.0

打开实时音视频

liveOpen

function liveOpen(params: GnssOpenLiveParams): Promise<ApiReply<GnssOpenStrmResult>> {
}

本方法用于指示终端向媒体服务实时推送指定通道的媒体流,并返回服务端分配的媒体地址。

  • 同一通道的实时音视频支持多个会话同时播放。
  • 要关闭实时音视频流,可调用 releaseStrmReq 方法

参数

参数名数据类型必要说明
paramsGnssOpenLiveParamsY打开实时音视频参数

GnssOpenLiveParams 打开实时音视频参数

属性名数据类型必要说明
simNostringY终端识别号
channelintY通道号。参见JT/T 1078标准定义的车载视频逻辑通道号定义表。对讲时,可以不指定通道号。其他情况,通道号为必填。
dataTypeint数据类型:
  • 0: 音视频
  • 1: 视频
  • 2: 双向对讲
  • 3: 监听
  • 4: 中心广播(暂不支持)
  • 5: 透传(暂不支持)
未指定时,视为:0
codeStreamint码流类型:
  • 0: 主码流
  • 1: 子码流
未指定时视为:0
protoint请求的客户端协议类型:
  • 0: FLV
  • 1: HLS(默认使用FMP4段格式)
  • 4: RTSP
未指定时视为:0
subProtostring子协议类型:
  • fmp4: 使用FMP4段格式,仅当proto1时可指定此子协议类型。此为默认值。
  • mpegts: 使用MPEG2-TS段格式,仅当proto1时可指定此子协议类型
connIdxint连接序号。用于后台分配不同的服务器给客户端。仅在同步模式时有意义。未指定时视为:0
asyncboolean是否采用异步打开模式。未指定时视为:false
saveOnServerboolean播放时是否同时存储在服务端的本地媒体存储目录。未指定时视为:false
traceint跟踪模式:
  • 0: 不跟踪
  • 1: 简要跟踪
  • 3: 全面跟踪
不指定时,视为:0
audioCfgAudioConfig指定返回的媒体流的音频格式。不指定时使用服务端配置的默认音频设置
rtspSrcRtspSource采用RTSP源进行播放。打开JT/T 1078协议终端时,不需要指定本属性。

AudioConfig

属性数据类型必要说明
sampleRateintY采样率。为下列值之一:
  • 8000
  • 11025
  • 22050
  • 44100
  • 48000
  • 64000
  • 96000
指定高于音频源的采样率不能提高音质
channelsintY声道数。为下列值之一:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 8
指定高于音频源的声道数不能提高音质

RtspSource

属性数据类型必要说明
urlstringY所要拉取的RTSP流源地址。如:rtsp://n11.gratour.info/test/strm1,此地址必须要能被媒体服务所能访问到。当媒体源要求鉴权时,可以在url中带用户名和密码(不推荐),如: rtsp://user:passwd@n11.gratour.info/test/strm1 ,此时,本结构的 userpwd属性被忽略
userstring当媒体源要求鉴权时,本属性指定用户名。当url属性中包含用户名时,本属性被忽略
pwdstring当媒体源要求鉴权时,本属性指定用户密码。当url属性中包含用户密码时,本属性被忽略

返回值

Promise<ApiReply<GnssOpenStrmResult>>

GnssOpenStrmResult 打开媒体流结果

属性数据类型必要说明
reqIdstringY由平台分配的请求ID,用于监测流通知,或播放控制
instanceIdstringY平台分配的流媒体实例ID
channelintY音视频逻辑通道号。参见JT/T 1078标准定义的车载视频逻辑通道号定义表
protointY请求的客户端协议类型:
  • 0: FLV
  • 1: HLS(默认使用FMP4段格式)
  • 4: RTSP
playUrlstringY播放地址
readybooleanY流是否已经可以播放。为false时,要等到收到act为ready的流媒体通知才能播放。
wsUrlstringWebSocket地址,用于对讲时客户端提交音频数据。此地址使用stomp协议。仅当请求的流类型为实时流,且数据类型(dataTyp)为2: 对讲时有效。
taUrlstringWebSocket地址,用于对讲时客户端提交音频数据。此地址使用二进制websocket协议。仅当请求的流类型为实时流,且数据类型(dataTyp)为2: 对讲时有效。
mediaTypstringY流的媒体类型:
  • av: 音频和视频
  • a: 仅音频
  • v: 仅视频