LocalStream

Extends

• Stream

Methods

initialize() → {Promise}

Example

// 例如：处理 NotReadableError 错误
localStream.initialize().then(() => {
  // 本地流初始化成功，发布本地流
  client.publish(localStream).then(() => {
  // 本地流发布成功
  })
}).catch((error) => {
  // 本地流初始化失败
   switch (error.name) {
     case 'NotReadableError':
       // 提示用户：暂时无法访问摄像头/麦克风，请确保当前没有其他应用请求访问摄像头/麦克风，并重试。
       break;
     default:
       console.error(error);
       break;
   }
})

Throws:

Returns:

Type

Promise

(async) setAudioProfile(profile)

Example

localStream.setAudioProfile('high');
localStream.initialize().then(() => {
  // localStream was initialized success
});

Parameters:

(async) setVideoProfile(profile) → {Promise}

Examples

// 使用预定义Profile设置
localStream.setVideoProfile('480p');
localStream.initialize().then(() => {
  // local stream was initialized successfully.
});

// 使用自定义视频Profile设置
localStream.setVideoProfile({
  width: 360, // 视频宽度
  height: 360, // 视频高度
  frameRate: 10, // 帧率
  bitrate: 400 // 比特率 kbps
});
localStream.initialize().then(() => {
  // local stream was initialized successfully.
});

// 动态设置 profile
localStream.setVideoProfile('480p');
await localStream.initialize();
await client.publish(localStream);
try {
   await localStream.setVideoProfile('1080p');
} catch(error) {
  if (error.name === 'OverconstrainedError') {
     console.error('当前摄像头不支持该 profile');
     // 设置失败，当前摄像头已停止采集，需要恢复采集
     const stream = TRTC.createStream({ video: true, audio: false });
     await stream.initialize();
     localStream.replaceTrack(stream.getVideoTrack());
  } else {
     console.error('当前浏览器不支持动态调用该接口');
  }
}

// 推流后更新码率
client.publish(localStream).then(() => {
   localStream.setVideoProfile({ bitrate: 1500 });
})

// 获取实际采集的分辨率和帧率
const videoTrack = localStream.getVideoTrack();
if (videoTrack) {
   const settings = videoTrack.getSettings();
   console.log(`分辨率：${settings.width} * ${settings.height}, 帧率：${settings.frameRate}`)
}
// 获取实际推流的视频码率参考：https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/Client.html#getLocalVideoStats

Parameters:

Returns:

Type

Promise

setScreenProfile(profile)

Example

// 指定 Profile
localStream.setScreenProfile('1080p');
localStream.initialize().then(() => {
  // local stream was initialized successfully
});
// 指定自定义分辨率、帧率和码率
localStream.setScreenProfile({ width: 1920, height: 1080, frameRate: 5, bitrate: 1600 });
localStream.initialize().then(() => {
  // local stream was initialized successfully
});

Parameters:

setVideoContentHint(hint)

Example

const localStream = TRTC.createStream({ userId, audio: false, screen: true });
localStream.initialize().then(() => {
  // 如果屏幕分享内容包含图片、文本，使用 'detail' 提示
  localStream.setVideoContentHint('detail');
  // 如果屏幕分享内容只包含大量文本，使用 'text' 提示
  // localStream.setVideoContentHint('text');
  client.publish(localStream);
});

Parameters:

(async) switchDevice(type, deviceId) → {Promise}

Example

// 切换本地流的摄像头
const localStream = TRTC.createStream({ userId, audio: true, video: true });
await localStream.initialize()
await client.publish(localStream);
const cameras = await TRTC.getCameras();
await localStream.switchDevice('video', cameras[0].deviceId)
//
// 切换本地屏幕分享流的麦克风，前提需要初始属性 audio 为 true，v4.11.9+支持
const localStream = TRTC.createStream({ userId, audio: true, screen: true });
await localStream.initialize()
client.publish(localStream);
const microphones = await TRTC.getMicrophones();
await localStream.switchDevice('video', microphones[0].deviceId)

Parameters:

Returns:

Type

Promise

(async) addTrack(track)

Example

const localStream = TRTC.createStream({ userId, audio: true, video: false });
localStream.initialize().then(() => {
  // 分布本地流（只有从麦克风采集的音频流）
  client.publish(localStream);
});
// ...
// 开启视频通话
const videoStream = TRTC.createStream({ userId, audio: false, video: true });
videoStream.initialize().then(() => {
  const videoTrack = videoStream.getVideoTrack();
  // 将从摄像头采集的视频轨道插入当前已发布的本地流对象LocalStream
  localStream.addTrack(videoTrack).then(() => {
    // 视频通话开启成功，远端流将会收到‘stream-updated’通知
  });
});
//

Parameters:

Throws:

(async) removeTrack(track)

Example

// 关闭视频通话示例，对应addTrack接口的开启视频通话示例
const videoTrack = localStream.getVideoTrack();
if (videoTrack) {
  localStream.removeTrack(videoTrack).then(() => {
    // 关闭视频通话成功，停止videoTrack并释放摄像头资源
    videoTrack.stop();
  });
}

Parameters:

Throws:

(async) replaceTrack(track)

Parameters:

Throws:

setAudioCaptureVolume(volumeopt) → {Boolean}

Since:

• v4.14.0

Example

// 采集声音减少一半
localStream.setAudioCaptureVolume(50);
// 采集声音设置为 0，相当于静音。
localStream.setAudioCaptureVolume(0);
// 采集声音增大50%。
localStream.setAudioCaptureVolume(150);
const result = localStream.setAudioCaptureVolume(50);
if (!result && localStream.hasAudio()) {
 // 当前浏览器不支持设置麦克风采集音量
}

Parameters:

Returns:

Type

Boolean

(async) play(elementId, optionsopt) → {Promise}

Inherited From:

• Stream#play

Example

// v4.8.4 以下版本, 请使用以下方式捕捉并处理 0x4043 错误
stream.play('remote').then(() => {
  // autoplay success
}).catch((error) => {
  const errorCode = error.getCode();
  if (errorCode === 0x4043) {
    // PLAY_NOT_ALLOWED,引导用户手势操作并调用 stream.resume 恢复音视频播放
    // stream.resume()
  }
});
// v4.8.4 及其以上版本, 强烈建议使用 stream 监听 error 的方式捕捉并处理 0x4043 错误
stream.play('remote').catch(error => {});
stream.on('error', error => {
  const errorCode = error.getCode();
  if (errorCode === 0x4043) {
    // PLAY_NOT_ALLOWED,引导用户手势操作并调用 stream.resume 恢复音视频播放
    // stream.resume()
  }
})

Parameters:

Throws:

Returns:

Type

Promise

stop()

Inherited From:

• Stream#stop

(async) resume() → {Promise}

Inherited From:

• Stream#resume

Example

stream.on('player-state-changed', event => {
  if (event.state === 'PAUSED') {
    // resume audio/video playback
    stream.resume();
  }
});

Throws:

Returns:

Type

Promise

close()

Overrides:

• Stream#close

muteAudio() → {boolean}

Overrides:

• Stream#muteAudio

Returns:

Type

boolean

muteVideo() → {boolean}

Overrides:

• Stream#muteVideo

Returns:

Type

boolean

unmuteAudio() → {boolean}

Overrides:

• Stream#unmuteAudio

Returns:

Type

boolean

unmuteVideo() → {boolean}

Overrides:

• Stream#unmuteVideo

Returns:

Type

boolean

getId() → {string}

Inherited From:

• Stream#getId

Returns:

Type

string

getUserId() → {string}

Inherited From:

• Stream#getUserId

Returns:

Type

string

(async) setAudioOutput(deviceId)

Inherited From:

• Stream#setAudioOutput

Parameters:

getAudioLevel() → {number}

Inherited From:

• Stream#getAudioLevel

Example

setInterval(() => {
  const level = stream.getAudioLevel();
  if (level >= 0.1) {
    console.log(`user ${stream.getUserId()} is speaking`);
  }
}, 200);

Returns:

Type

number

hasAudio() → {boolean}

Inherited From:

• Stream#hasAudio

Returns:

Type

boolean

hasVideo() → {boolean}

Inherited From:

• Stream#hasVideo

Returns:

Type

boolean

getAudioTrack() → (nullable) {MediaStreamTrack}

Inherited From:

• Stream#getAudioTrack

Returns:

Type

MediaStreamTrack

getVideoTrack() → (nullable) {MediaStreamTrack}

Inherited From:

• Stream#getVideoTrack

Returns:

Type

MediaStreamTrack

getVideoFrame() → (nullable) {String}

Inherited From:

• Stream#getVideoFrame

Example

// 截取当前视频帧
const frame = stream.getVideoFrame();
if (frame) {
  const img = document.createElement('img');
  img.src = frame;
}

Returns:

Type

String

on(eventName, handler, context)

Inherited From:

• Stream#on

Example

function onPlayerStateChange(event) {
   console.log(`${event.type} player is ${event.state}`);
}
stream.on('player-state-changed', onPlayerStateChange);

Parameters:

off(eventName, handler, context)

Inherited From:

• Stream#off

Example

function onPlayerStateChange(event) {
   console.log(`${event.type} player is ${event.state}`);
}
stream.on('player-state-changed', onPlayerStateChange);
stream.off('player-state-changed', onPlayerStateChange);

Parameters: