Media track APIs - STMLink Docs

All of the following media objects are obtained through ISMeetingChannel.

Local media stream APIs

Get the local microphone object

virtual StatusCode getLocalMic(IMEETLocalMic**) = 0;

Parameters

Parameter	Type	Description
(output)	IMEETLocalMic**	Output pointer to the local microphone object

Returns StatusCode - Error code

Get the local camera object

virtual StatusCode getLocalCamera(IMEETLocalCamera**) = 0;

Parameters

Parameter	Type	Description
(output)	IMEETLocalCamera**	Output pointer to the local camera object

Returns StatusCode - Error code

virtual StatusCode getLocalScreen(IMEETLocalScreen**) = 0;

Parameters

Parameter	Type	Description
(output)	IMEETLocalScreen**	Output pointer to the local screen sharing object

Returns StatusCode - Error code

Remote media stream APIs

Get a remote video object

virtual StatusCode getRemoteVideo(std::string uid, std::string track_desc, IMEETRemoteVideo**) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
track_desc	std::string	Track description
(output)	IMEETRemoteVideo**	Output pointer to the remote video object

Returns StatusCode - Error code

Get a remote audio object

virtual StatusCode getRemoteAudio(std::string uid, IMEETRemoteAudio**) = 0;

Parameters

Parameter	Type	Description
uid	std::string	User ID
(output)	IMEETRemoteAudio**	Output pointer to the remote audio object

Returns StatusCode - Error code

Get the MCU video object

virtual StatusCode getMcuVideo(IMEETRemoteVideo**) = 0;

Parameters

Parameter	Type	Description
(output)	IMEETRemoteVideo**	Output pointer to the MCU video object

Returns StatusCode - Error code

Custom track APIs

Get a custom video track

virtual StatusCode getCustomVideo(CustomPublishTrack* push, IMeetCustomVideoTrack**) = 0;

Parameters

Parameter	Type	Description
push	CustomPublishTrack*	Custom track configuration
(output)	IMeetCustomVideoTrack**	Output pointer to the custom video track object

Returns StatusCode - Error code

Get a custom audio track

virtual StatusCode getCustomAudio(CustomPublishTrack* push, IMeetCustomAudioTrack**) = 0;

Parameters

Parameter	Type	Description
push	CustomPublishTrack*	Custom track configuration
(output)	IMeetCustomAudioTrack**	Output pointer to the custom audio track object

Returns StatusCode - Error code

Set the custom receive callback

virtual StatusCode setCustomRecvBack(RTC_Custom_FrameEvent e, void* ext) = 0;

Parameters

Parameter	Type	Description
e	RTC_Custom_FrameEvent	Frame event callback function
ext	void*	Extension data

Returns StatusCode - Error code

Local recording APIs

Get the local recording object

virtual StatusCode getLocalRecord(IMEETRecord** e) = 0;

Parameters

Parameter	Type	Description
e	IMEETRecord**	Pointer to the recording object

Returns StatusCode - Error code

Starting with 1.0.0-alpha.5, you no longer pass in a meeting ID; the current channel object’s own meeting ID is used.

IMEETLocalMic methods

Request to turn on the microphone

virtual StatusCode requestOpenMic(Callback back = NULL) = 0;

Turn off the microphone

virtual StatusCode closeMic(Callback back = NULL) = 0;

Switch microphones

virtual StatusCode switchMic(std::string name) = 0;

Confirm turning on the microphone

virtual StatusCode confirmOpenMic(bool approve, std::string uid, Callback function = NULL) = 0;

IMEETLocalCamera methods

Inherits from IMEETVideo.

Switch cameras

virtual StatusCode switchCamera(std::string name, int w = 0, int h = 0) = 0;

Request to turn on the camera

virtual StatusCode requestOpenCamera(Callback back = NULL) = 0;

Turn off the camera

virtual StatusCode closeCamera(Callback back = NULL) = 0;

Confirm turning on the camera

virtual StatusCode confirmOpenCamera(bool approve, std::string uid, Callback function = nullptr) = 0;

IMEETLocalScreen methods

Inherits from IMEETVideo.

virtual StatusCode requestShare(int tp, std::string data, Callback back = NULL) = 0;

virtual StatusCode stopShare(Callback back = NULL) = 0;

Add screen audio

virtual StatusCode addScreenAudio(bool) = 0;

Update the stream output

virtual StatusCode updateStreamOutput(int w, int h) = 0;

virtual StatusCode confirmOpenShare(int tp, std::string data, Callback back = NULL) = 0;

IMEETRemoteVideo methods

Inherits from IMEETVideo.

Load the remote video

virtual StatusCode loadRemoteVideo() = 0;

Unload the remote video

virtual StatusCode unLoadRemoteVideo() = 0;

IMEETRemoteAudio methods

Turn on the speaker

virtual StatusCode openSpeaker() = 0;

Turn off the speaker

virtual StatusCode closeSpeaker() = 0;

Switch speakers

virtual StatusCode switchSpeaker(std::string name) = 0;

IMEETRecord methods

Set the recording file name

virtual StatusCode setRecordFileName(std::string filepath) = 0;

Set the watermark

virtual StatusCode setWaterMask(std::string mask) = 0;

Start recording

virtual StatusCode startRecord() = 0;

Set the recording window

virtual StatusCode setRecordHwnd(void*, int, int, int, int) = 0;

Set the recording layout member views

virtual StatusCode setRecordLayoutMemberView(std::string json) = 0;

Pause recording

virtual StatusCode pauseRecord() = 0;

Stop recording

virtual StatusCode stopRecord() = 0;

IMEETVideo methods

Add a playback view

virtual StatusCode addPlayView(IRTCView* v) = 0;

Remove a playback view

virtual StatusCode removePlayView(IRTCView* v) = 0;

Remove all playback views

virtual StatusCode removeAllPlayView() = 0;