LocalStream

Extends

• Stream

Methods

initialize() → {Promise}

Example

// Handle the `NotReadableError` error
localStream.initialize().then(() => {
  // Publish the local stream after successful local stream initialization
  client.publish(localStream).then(() => {
  // Publishing the local stream is successful
  })
}).catch((error) => {
  // Failed to initialize local stream
   switch (error.name) {
     case 'NotReadableError':
       // Send this message to the user: "The camera/mic cannot be accessed. Please make sure that no other applications are requesting access and try again."
       break;
     default:
       console.error(error);
       break;
   }
})

Returns:

Type

Promise

setAudioProfile(profile)

Example

localStream.setAudioProfile('high');
localStream.initialize().then(() => {
  // Local stream initialized successfully
});

Parameters:

(async) setVideoProfile(profile) → {Promise}

Examples

// Use predefined profile settings
localStream.setVideoProfile('480p');
localStream.initialize().then(() => {
  // Local stream initialized successfully
});

// Use custom video profile settings
localStream.setVideoProfile({
  width: 360, // Video width
  height: 360, // Video height
  frameRate: 10, // Frame rate
  bitrate: 400 // Bitrate (Kbps)
});
localStream.initialize().then(() => {
  // Local stream initialized successfully
});

// Dynamically set a profile
localStream.setVideoProfile('480p');
await localStream.initialize();
await client.publish(localStream);
try {
   await localStream.setVideoProfile('1080p');
} catch(error) {
  if (error.name === 'OverconstrainedError') {
     console.error('The current camera does not support the profile');
     // Setting failed. Capturing via the current camera is stopped and needs to be resumed
     const stream = TRTC.createStream({ video: true, audio: false });
     await stream.initialize();
     localStream.replaceTrack(stream.getVideoTrack());
  } else {
     console.error('The current browser does not support dynamic calling of this API');
  }
}

// Update the bitrate after push
client.publish(localStream).then(() => {
   localStream.setVideoProfile({ bitrate: 1500 });
})

// Get the resolution and frame rate for actual capturing
const videoTrack = localStream.getVideoTrack();
if (videoTrack) {
   const settings = videoTrack.getSettings();
   console.log(`Resolution: ${settings.width} * ${settings.height}; frame rate: ${settings.frameRate}`)
}
// Get the video bitrate for actual push. Reference: https://web.sdk.qcloud.com/trtc/webrtc/doc/en/Client.html#getLocalVideoStats

Parameters:

Returns:

Type

Promise

setScreenProfile(profile)

Example

// Specify a profile
localStream.setScreenProfile('1080p');
localStream.initialize().then(() => {
  // Local stream initialized successfully
});
// Specify a custom resolution, frame rate, and bitrate
localStream.setScreenProfile({ width: 1920, height: 1080, frameRate: 5, bitrate: 1600 });
localStream.initialize().then(() => {
  // Local stream initialized successfully
});

Parameters:

setVideoContentHint(hint)

Example

const localStream = TRTC.createStream({ userId, audio: false, screen: true });
localStream.initialize().then(() => {
  // If the main content for the current screen sharing is general web pages
  localStream.setVideoContentHint('detail');
  // If the main content for the current screen sharing contains a lot of text
  // localStream.setVideoContentHint('text');
  client.publish(localStream);
});

Parameters:

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

Example

await client.publish(localStream);
const cameras = await TRTC.getCameras();
await localStream.switchDevice('video', cameras[0].deviceId)

Parameters:

Returns:

Type

Promise

(async) addTrack(track)

Example

const localStream = TRTC.createStream({ userId, audio: true, video: false });
localStream.initialize().then(() => {
  // Publish local stream (only the audio stream captured from the mic)
  client.publish(localStream);
});
// ...
// Enable video call
const videoStream = TRTC.createStream({ userId, audio: false, video: true });
videoStream.initialize().then(() => {
  const videoTrack = videoStream.getVideoTrack();
  // Insert the video track captured from the camera into the currently published local stream object `LocalStream`
  localStream.addTrack(videoTrack).then(() => {
    // When video call is enabled successfully, the remote device will receive the `stream-updated` notification
  });
});
//

Parameters:

Throws:

(async) removeTrack(track)

Example

// Disable video call, corresponding to the example of video call enabling via the `addTrack` API
const videoTrack = localStream.getVideoTrack();
if (videoTrack) {
  localStream.removeTrack(videoTrack).then(() => {
    // Video call disabled successfully. Stop `videoTrack` and release the camera resource
    videoTrack.stop();
  });
}

Parameters:

Throws:

(async) replaceTrack(track)

Parameters:

Throws:

setAudioCaptureVolume(volumeopt) → {Boolean}

Since:

• v4.14.0

Example

// set the capture volume in half
localStream.setAudioCaptureVolume(50);
// set the capture volume to 0
localStream.setAudioCaptureVolume(0);
// increase the capture volume by 1.5 times
localStream.setAudioCaptureVolume(150);
const result = localStream.setAudioCaptureVolume(50);
if (!result && localStream.hasAudio()) {
 // not supported in current browser.
}

Parameters:

Returns:

Type

Boolean

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

Inherited From:

• Stream#play

Example

// For versions earlier than v4.8.4, capture and handle the 0x4043 error as follows.
stream.play('remote').then(() => {
  // autoplay success
}).catch((error) => {
  const errorCode = error.getCode();
  if (errorCode === 0x4043) {
    // If the `PLAY_NOT_ALLOWED` error occurs, display a window on the UI and, in the callback for the window’s clicking event, call `stream.resume` to resume audio/video playback.
    // stream.resume()
  }
});
// For v4.8.4 and later versions, we strongly recommend that you use the error callback of `Stream` to capture and handle the 0x4043 error.
stream.play('remote').catch(error => {});
stream.on('error', error => {
  const errorCode = error.getCode();
  if (errorCode === 0x4043) {
    // If the `PLAY_NOT_ALLOWED` error occurs, display a window on the UI and, in the callback for the window’s clicking event, call `stream.resume` to resume audio/video playback.
    // 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() → {MediaStreamTrack}

Inherited From:

• Stream#getAudioTrack

Returns:

Type

MediaStreamTrack

getVideoTrack() → {MediaStreamTrack}

Inherited From:

• Stream#getVideoTrack

Returns:

Type

MediaStreamTrack

getVideoFrame() → {String}

Inherited From:

• Stream#getVideoFrame

Example

// Get the current video frame
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: