Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTok.VideoTransformer

Defines a video transformation to be used in the Publisher.VideoTransformers array. More...

Inherits IDisposable.

Public Member Functions

 VideoTransformer (string name, string properties)
 Creates a video transformer from a Vonage Media Library transformer. For more information, see Using the Vonage Media Processor library. More...
 VideoTransformer (string name, ICustomVideoTransformer transformer)
 Creates a custom video transformer. More...
void Dispose ()
 Disposes of the VideoTransformer object's resources. More...

Protected Member Functions

virtual void Dispose (bool disposing)

Detailed Description

Defines a video transformation to be used in the Publisher.VideoTransformers array.

Constructor & Destructor Documentation

◆ VideoTransformer() [1/2]

OpenTok.VideoTransformer.VideoTransformer ( string  name,
string  properties 
)

Creates a video transformer from a Vonage Media Library transformer. For more information, see Using the Vonage Media Processor library.

Parameters
nameThe name of the Vonage Media Library transformer. Currently, only one transformer is supported: background blur. Set the name parameter to "BackgroundBlur".
propertiesThe JSON string with the properties of the vonage transformer. For a background blur transformer, the format of the JSON is "{\"radius\":\"High\"}", where valid values for the radius property are "None", "High", and "Low". For a custom background blur transformer, the format of the JSON is "{\"radius":\"Custom\",\"custom_radius\":\"value\"}", where custom_radius can be any positive integer.

◆ VideoTransformer() [2/2]

OpenTok.VideoTransformer.VideoTransformer ( string  name,
ICustomVideoTransformer  transformer 
)

Creates a custom video transformer.

Parameters
nameThe unique identifier for the transformer.
transformerThe object that includes a callback method to perform the transformation.

Member Function Documentation

◆ Dispose() [1/2]

virtual void OpenTok.VideoTransformer.Dispose ( bool  disposing)

Parameters
disposing

◆ Dispose() [2/2]

void OpenTok.VideoTransformer.Dispose ( )

Disposes of the VideoTransformer object's resources.