Inherits from NSObject
Declared in OTPublisherKit.h

Overview

Defines a transformer of a video stream.

– initWithName:properties:

Creates an instance of a Vonage video transformer. For more information, see Using the Vonage Media Processor library. Note: Media transformers are not supported on all devices or iOS versions — see this documentation.

- (nullable id)initWithName:(nonnull NSString *)name properties:(nonnull NSString *)properties

Parameters

name

The name of the Vonage transformer. Currently, “BackgroundBlur” and “BackgroundReplacement” are supported.
properties

A JSON string with the properties of the Vonage video transformer. For a background blur transformer, the format of the JSON is “{\"radius\”:\“None\”}“. Valid values for the radius property a 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. For a background replacement transformer, the format of the JSON is ”{\“image_file_path\”:\“path/to/image\”}“, where image_file_path is the absolute file path of a local image to use as virtual background. Supported image formats are PNG and JPEG.

Declared In

OTPublisherKit.h

– initWithName:transformer:

Creates an instance of a custom video transformer.

- (nullable id)initWithName:(nonnull NSString *)name transformer:(nonnull id<OTCustomVideoTransformer>)transformer

Parameters

name

The identifier for the transformer.
transformer

The transformer.

Return Value

NULL if an error occurs.

Declared In

OTPublisherKit.h