Abstract Adds one IMediaEngineEvent listener. After calling this method, you can listen for the corresponding events in the IMediaEngine object and obtain data through IMediaEngineEvent. Depending on your project needs, you can add multiple listeners for the same event.
The name of the target event to listen for. See IMediaEngineEvent.
The callback function for eventType. Take adding a listener for onPlaybackAudioFrameBeforeMixing as an example: // Create an onPlaybackAudioFrameBeforeMixing object const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; // Add one onPlaybackAudioFrameBeforeMixing listener engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
Abstract createCreates a custom audio track.
Call this method before joining a channel. To publish a custom audio source, see the following steps: Call this method to create a custom audio track and get the audio track ID. Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true. Call pushAudioFrame and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.
If the method call is successful, the audio track ID is returned as the unique identifier of the audio track. If the method call fails, 0xffffffff is returned.
The type of the custom audio track. See AudioTrackType. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
The configuration of the custom audio track. See AudioTrackConfig.
Abstract destroyAbstract pullPulls the remote audio data.
After a successful call of this method, the app pulls the decoded and mixed audio data for playback.
The AudioFrame instance, if the method call succeeds. An error code, if the call fails,.
Abstract pushPushes the external audio frame.
Call this method to push external audio frames through the audio track.
0: Success. < 0: Failure.
The external audio frame. See AudioFrame.
Optional trackId: numberThe audio track ID. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
Abstract pushPushes the external raw video frame to the SDK through video tracks.
To publish a custom video source, see the following steps: Call createCustomVideoTrack to create a video track and get the video track ID. Call joinChannel to join the channel. In ChannelMediaOptions, set customVideoTrackId to the video track ID that you want to publish, and set publishCustomVideoTrack to true. Call this method and specify videoTrackId as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel. After calling this method, even if you stop pushing external video frames to the SDK, the custom video stream will still be counted as the video duration usage and incur charges. Agora recommends that you take appropriate measures based on the actual situation to avoid such video billing. If you no longer need to capture external video data, you can call destroyCustomVideoTrack to destroy the custom video track. If you only want to use the external video data for local preview and not publish it in the channel, you can call muteLocalVideoStream to cancel sending video stream or call updateChannelMediaOptions to set publishCustomVideoTrack to false.
0: Success. < 0: Failure.
The external raw video frame to be pushed. See ExternalVideoFrame.
Optional videoTrackId: numberThe video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
Abstract registerRegisters an audio frame observer object.
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger the onMixedAudioFrame, onRecordAudioFrame, onPlaybackAudioFrame, onPlaybackAudioFrameBeforeMixing or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.
0: Success. < 0: Failure.
The observer instance. See IAudioFrameObserver. Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
Abstract registerRegisters a facial information observer.
You can call this method to register the onFaceInfo callback to receive the facial information processed by Agora speech driven extension. When calling this method to register a facial information observer, you can register callbacks in the IFaceInfoObserver class as needed. After successfully registering the facial information observer, the SDK triggers the callback you have registered when it captures the facial information converted by the speech driven extension. Call this method before joining a channel. Before calling this method, you need to make sure that the speech driven extension has been enabled by calling enableExtension.
0: Success. < 0: Failure.
Facial information observer, see IFaceInfoObserver.
Abstract registerRegisters a receiver object for the encoded video image.
If you only want to observe encoded video frames (such as H.264 format) without decoding and rendering the video, Agora recommends that you implement one IVideoEncodedFrameObserver class through this method. Call this method before joining a channel.
0: Success. < 0: Failure.
The video frame observer object. See IVideoEncodedFrameObserver.
Abstract registerRegisters a raw video frame observer object.
If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one IVideoFrameObserver class with this method. When calling this method to register a video observer, you can register callbacks in the IVideoFrameObserver class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
0: Success. < 0: Failure.
The observer instance. See IVideoFrameObserver.
Removes all listeners for the specified event.
Optional eventType: EventTypeThe name of the target event to listen for. See IMediaEngineEvent.
Removes the specified IMediaEngineEvent listener. For listened events, if you no longer need to receive the callback message, you can call this method to remove the corresponding listener.
The name of the target event to listen for. See IMediaEngineEvent.
Optional listener: IMediaEngineEvent[EventType]The callback function for eventType. Must pass in the same function object in addListener . Take removing the listener for onJoinChannelSuccess as an example: // Create an onPlaybackAudioFrameBeforeMixing object const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {}; // Add one onPlaybackAudioFrameBeforeMixing listener engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing); // Remove the onPlaybackAudioFrameBeforeMixing listener engine.removeListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
Abstract setSets the external audio sink.
After enabling the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
0: Success. < 0: Failure.
Whether to enable or disable the external audio sink: true : Enables the external audio sink. false : (Default) Disables the external audio sink.
The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
The number of audio channels of the external audio sink: 1: Mono. 2: Stereo.
Abstract setSets the external audio source parameters.
Deprecated: This method is deprecated, use createCustomAudioTrack instead.
0: Success. < 0: Failure.
Whether to enable the external audio source: true : Enable the external audio source. false : (Default) Disable the external audio source.
The sample rate (Hz) of the external audio source which can be set as 8000, 16000, 32000, 44100, or 48000.
The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).
Optional localPlayback: booleanWhether to play the external audio source: true : Play the external audio source. false : (Default) Do not play the external source.
Optional publish: booleanWhether to publish audio to the remote users: true : (Default) Publish audio to the remote users. false : Do not publish audio to the remote users.
Abstract setConfigures the external video source.
After calling this method to enable an external video source, you can call pushVideoFrame to push external video data to the SDK.
0: Success. < 0: Failure.
Whether to use the external video source: true : Use the external video source. The SDK prepares to accept the external video frame. false : (Default) Do not use the external video source.
Whether to use the external video frame in the Texture format. true : Use the external video frame in the Texture format. false : (Default) Do not use the external video frame in the Texture format.
Optional sourceType: ExternalVideoSourceTypeWhether the external video frame is encoded. See ExternalVideoSourceType.
Optional encodedVideoOption: SenderOptionsVideo encoding options. This parameter needs to be set if sourceType is EncodedVideoFrame. To set this parameter, contact.
Abstract unregisterUnregisters an audio frame observer.
0: Success. < 0: Failure.
The audio frame observer, reporting the reception of each audio frame. See IAudioFrameObserver.
Abstract unregisterUnregisters a facial information observer.
0: Success. < 0: Failure.
Facial information observer, see IFaceInfoObserver.
Abstract unregisterUnregisters a receiver object for the encoded video frame.
0: Success. < 0: Failure.
The video observer, reporting the reception of each video frame. See IVideoEncodedFrameObserver.
Abstract unregisterUnregisters the video frame observer.
0: Success. < 0: Failure.
The video observer, reporting the reception of each video frame. See IVideoFrameObserver.
Generated using TypeDoc
The IMediaEngine class.