IVSMixedImageDeviceSourceConfiguration

Objective-C


@interface IVSMixedImageDeviceSourceConfiguration : NSObject

Swift

class IVSMixedImageDeviceSourceConfiguration : NSObject

Configuration for an IVSMixedImageDeviceSource.

  • The aspect ratio of the associated source.

    By default this is IVSAspectMode.Fit.

    Declaration

    Objective-C

    @property (nonatomic) IVSAspectMode aspect;

    Swift

    var aspect: IVSBroadcastConfiguration.AspectMode { get set }

  • The position of the associated source. By default this is 0x0

    Declaration

    Objective-C

    @property (nonatomic) CGPoint position;

    Swift

    var position: CGPoint { get set }

  • The size for the associated source. If the associated source provides samples that don’t match this size, they will be scaled based on the aspect value set on this configuration.

    By default this is 720x1280.

    Declaration

    Objective-C

    @property (nonatomic) CGSize size;

    Swift

    var size: CGSize { get set }

  • The alpha for the associated source. 1 = fully opaque, 0 = fully transparent.

    By default this is 1.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float alpha;

    Swift

    var alpha: Float { get }

  • Sets the alpha for the associated source. 1 = fully opaque, 0 = fully transparent The value must be between 0 and 1 and IVSMixedImageDevice must have been created with transparencyEnabled set to YES, otherwise alpha will not be set and the provided outError will be set.

    Note

    For alpha to work, the IVSMixedImageDevice that the associated source is attached to must have been created with transparencyEnabled set to YES.

    Declaration

    Objective-C

    - (BOOL)setAlpha:(float)alpha error:(NSError *_Nullable *_Nullable)outError;

    Swift

    func setAlpha(_ alpha: Float) throws

    Parameters

    alpha

    The alpha of the associated source.
    outError

    On input, a pointer to an error object. If an error occurs, the pointer is an NSError object that describes the error. If you don’t want error information, pass in nil.

    Return Value

    if the set operation is successful or not.

  • The z-index of the associated source. Higher values are rendered on top of lower values. By default this is 0.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger zIndex;

    Swift

    var zIndex: Int { get set }

  • The fill color for content that is not used by media samples from the device attached to the associated source. For example, if a 4:3 device is attached to a 16:9 source, this fill color will be used as the background color for the letterboxing based on the aspect value.

    By default this is UIColor.clear.

    Declaration

    Objective-C

    @property (nonatomic, strong) UIColor *_Nonnull fillColor;

    Swift

    var fillColor: UIColor { get set }