Version: 20 Mar 2024

AppDefinedVideoSource

Class that represents an app defined video source that can be used by the MLWebRTC API. More...

Detailed Description

public class AppDefinedVideoSource : AppDefinedSource 

Details*

Class that represents a source used by the MLWebRTC API.

Destroys the Track and its associated media source.

public virtual override MLResult DestroyLocal()

Reimplements: DestroyLocal

Initializes the given AppDefinedVideoSource object.

public static MLResult InitializeLocal(
    AppDefinedVideoSource appDefinedVideoSource
)

Parameters

Type	Name	Description
AppDefinedVideoSource	appDefinedVideoSource	The AppDefinedVideoSource object to initialize.
	result	The MLResult object of the inner platform call(s).

Returns: An AppDefinedVideoSource object with the given handle.

Pushes a frame into the defined video source.

protected MLResult PushFrame(
    VideoSink.Frame frame
)

Parameters

Type	Name	Description
VideoSink.Frame	frame	The frame to push to the video source.

Returns: MLResult.Result will be MLResult.Code.Ok if destroying all handles was successful. MLResult.Result will be MLResult.Code.WebRTCResultInstanceNotCreated if MLWebRTC instance was not created. MLResult.Result will be MLResult.Code.InvalidParam if an invalid parameter was passed. MLResult.Result will be MLResult.Code.WebRTCResultMismatchingHandle if an incorrect handle was sent. MLResult.Result will be MLResult.Code.WebRTCResultInvalidFrameFormat if an invalid frame format was specified. MLResult.Result will be MLResult.Code.WebRTCResultInvalidFramePlaneCount if an invalid plane count was specified for the given frame format. MLResult.Result will be MLResult.Code.WebRTCSendNativeFrameError pushing a native format frame fails.