TRTCStreamMixingConfig class

The Transcoding Parameters

This enum type is used by the publishing API startPublishMediaStream.

You can use this parameter to specify the video layout and input audio information for On-Cloud MixTranscoding.

Constructors

TRTCStreamMixingConfig({int backgroundColor = 0, Uint8List? backgroundImage, List<TRTCVideoLayout>? videoLayoutList, List<TRTCUser>? audioMixUserList, List<TRTCWatermark>? watermarkList})

Properties

audioMixUserList ↔ List<TRTCUser>
  • Description: The information of each audio stream to mix.
  • Value: This parameter is an array. Each TRTCUser element in the array indicates the information of an audio stream.
  • Note: If you do not specify this array, the TRTC backend will automatically mix all streams of the anchors who are sending audio in the room according to the audio encode param TRTCStreamEncoderParam you specify (currently only supports up to 16 audio and video inputs).
    • getter/setter pair
    backgroundColor ↔ int
  • Description: The background color of the mixed stream.
  • Value: The value must be a hex number. For example, "0x61B9F1" represents the RGB color value (97,158,241). Default value: 0x000000 (black).
    • getter/setter pair
    backgroundImage ↔ Uint8List
  • Description: The URL of the background image of the mixed stream. The image specified by the URL will be mixed during On-Cloud MixTranscoding.
  • Value: This parameter is left empty by default, which means no background image will be used.
  • Note:
    • The URL can be 512 bytes long at most, and the image must not exceed 2 MB.
    • The image can be in PNG, JPG, JPEG, or BMP format. We recommend you use a semitransparent image in PNG format.
    • getter/setter pair
    hashCode → int
    The hash code for this object.
    no setterinherited
    runtimeType → Type
    A representation of the runtime type of the object.
    no setterinherited
    videoLayoutList ↔ List<TRTCVideoLayout>
  • Description: The position, size, layer, and stream type of each video in On-Cloud MixTranscoding.
  • Value: This parameter is an array. Each TRTCVideoLayout element in the array indicates the information of a video in On-Cloud MixTranscoding.
    • getter/setter pair
    watermarkList ↔ List<TRTCWatermark>
  • Description: The position, size, and layer of each watermark image in On-Cloud MixTranscoding.
  • Value: This parameter is an array. Each TRTCWatermark element in the array indicates the information of a watermark.
    • getter/setter pair

    Methods

    noSuchMethod(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
    inherited
    toString() → String
    A string representation of this object.
    inherited

    Operators

    operator ==(Object other) → bool
    The equality operator.
    inherited