MixedStreamLayoutRegionConfig class
- Inheritance
-
- Object
- NativeClass
- MixedStreamLayoutRegionConfig
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
alpha
↔ FutureOr<double?>
-
@detail api
@brief Sets the transparency.
@param alpha (Only server-side stream mixing can set this parameter.) The opacity in range of (0.0, 1.0]. The lower value, the more transparent. The default value is 1.0.
getter/setter pair
-
alternateImageFillMode
↔ FutureOr<MixedStreamAlternateImageFillMode?>
-
@valid since 3.57
@detail api
@brief Sets the fill mode of the placeholder image.
This method is used to control the fill mode of the placeholder image after the user stops publishing video streams and the screen reverts to the placeholder image.
@param alternateImageFillMode See MixedStreamAlternateImageFillMode{@link #MixedStreamAlternateImageFillMode}.
getter/setter pair
-
alternateImageURL
↔ FutureOr<String?>
-
@valid since 3.57
@detail api
@brief Sets the URL of the placeholder image
@param alternateImageUrl Limited to a maximum of 1024 characters
getter/setter pair
-
applySpatialAudio
↔ FutureOr<boolean?>
-
@detail api
@brief Sets whether a user applies spatial audio effects.
@param applySpatialAudio Whether the user applies spatial audio effects:
- true: Yes (default setting)
- false: No
getter/setter pair
-
cornerRadius
↔ FutureOr<double?>
-
@detail api
@brief Sets the corner radius.
@param cornerRadius (Only server-side stream mixing can set this parameter.) The proportion of the radius to the width of the canvas. The default value is 0.0.
@note After you set the value,
width_px, height_px, and radius_px are calculated based on width, height, radius, and the width of the canvas. If radius_px < min(width_px/2, height_px/2) is met, the value of radius is set valid; if not, radius_px is set to min(width_px/2, height_px/2), and radius is set to the proportion of radius_px to the width of the canvas.
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
height
↔ FutureOr<int?>
-
@valid since 3.57
@detail api
@brief Sets the height of the user's frame in pixels.
@param height The height of the user's frame. The value range is
0, the height of the canvas. The default value is 640.
getter/setter pair
-
imageWaterMark
↔ FutureOr<ArrayBuffer?>
-
@detail api
@brief The RGBA data of the watermark.
@param imageWaterMark The RGBA data of the mixing image. Put in null when mixing video streams. It is required when the regionContentType is set to
MIXED_STREAM_LAYOUT_REGION_TYPE_IMAGE(1).
Put in null when you choose MIXED_STREAM_LAYOUT_REGION_TYPE_VIDEO_STREAM(0) as regionContentType.
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
imageWaterMarkConfig
↔ FutureOr<MixedStreamLayoutRegionImageWaterMarkConfig?>
-
@detail api
@brief Sets the resolution of the watermark.
@param imageWaterMarkConfig The resolution of the watermark.
It is required when the
regionContentType is set to MIXED_STREAM_LAYOUT_REGION_TYPE_IMAGE(1). See MixedStreamLayoutRegionImageWaterMarkConfig{@link #MixedStreamLayoutRegionConfig-MixedStreamLayoutRegionImageWaterMarkConfig}.
Put in null when you choose MIXED_STREAM_LAYOUT_REGION_TYPE_VIDEO_STREAM(0) as regionContentType.
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
isLocalUser
↔ FutureOr<boolean?>
-
@detail api
@brief Sets whether the source user of the stream is a local user.
@param islocalUser
- true: Yes
- false: No
getter/setter pair
-
locationX
↔ FutureOr<int?>
-
@valid since 3.57
@detail api
@brief Sets the X-coordinate in pixels of the upper-left corner of the user's frame in the entire canvas coordinate system, where the origin is at the upper-left corner of the canvas. It represents the horizontal displacement of the upper-left corner of the user's frame relative to the origin.
@param locationX The X-coordinate of the upper-left corner of the user's frame. The value range is [0, the width of the canvas). The default value is 0.
getter/setter pair
-
locationY
↔ FutureOr<int?>
-
@valid since 3.57
@detail api
@brief Sets the Y-coordinate in pixels of the upper-left corner of the user's frame in the entire canvas coordinate system, where the origin is at the upper-left corner of the canvas. It represents the vertical displacement of the upper-left corner of the user's frame relative to the origin.
@param locationY The Y-coordinate of the upper-left corner of the user's frame. The value range is [0, the height of the canvas). The default value is 0.
getter/setter pair
-
mediaType
↔ FutureOr<MixedStreamMediaType?>
-
@detail api
@brief (Only server-side stream mixing can set this parameter.) Sets the stream mixing content type.
@param mediaType The stream mixing content type. The default value is
MIXED_STREAM_MEDIA_TYPE_AUDIO_AND_VIDEO(0). See MixedStreamMediaType{@link #MixedStreamMediaType}.
getter/setter pair
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
regionContentType
↔ FutureOr<MixedStreamLayoutRegionType?>
-
@detail api
@brief Sets the stream mixing region type.
@param regionContentType Stream mixing region type. See MixedStreamLayoutRegionType{@link #MixedStreamLayoutRegionType}.
getter/setter pair
-
renderMode
↔ FutureOr<MixedStreamRenderMode?>
-
@detail api
@brief Sets the render mode.
@param renderMode The render mode. See MixedStreamRenderMode{@link #MixedStreamRenderMode}. The default value is 1.
getter/setter pair
-
roomID
↔ FutureOr<String?>
-
@detail api
@brief Sets the room ID of the user who publishes the video stream.
@param roomID The room ID to be set. Required.
@note
This parameters cannot be updated during.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceCrop
↔ FutureOr<SourceCrop?>
-
@brief Configurations on how to crop the WTN stream.
@param sourceCrop Refer to SourceCrop{@link #SourceCrop} for more details.
@note
This parameter is not supported for mixing-stream tasks.
getter/setter pair
-
spatialPosition
↔ FutureOr<Position?>
-
@detail api
@brief Sets spatial audio position of the current region.
@param spatialPosition Spatial position of current region. See Position{@link #Position}.
@note
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
streamType
↔ FutureOr<MixedStreamVideoType?>
-
@detail api
@brief Sets the stream type in the region.
@param streamType Stream type, see MixedStreamVideoType{@link #MixedStreamVideoType}. Only server-side stream mixing can set this parameter to "MIXED_STREAM_VIDEO_TYPE_SCREEN".
getter/setter pair
-
userID
↔ FutureOr<String?>
-
@detail api
@brief Sets the user ID of the user who publishes the video stream.
@param userID The user ID to be set.
@note
This parameters cannot be updated during.
getter/setter pair
-
width
↔ FutureOr<int?>
-
@valid since 3.57
@detail api
@brief Sets the width of the user's frame in pixels.
@param width The width of the user's frame. The value range is
0, the width of the canvas. The default value is 360.
getter/setter pair
-
zOrder
↔ FutureOr<int?>
-
@detail api
@brief Sets the layer on which the video is rendered.
@param zOrder The layer to be set. The range is
0, 100. 0 for the bottom layer, and 100 for the top layer. The default value is 0.
getter/setter pair
