ByteRTCMixedStreamLayoutRegionConfig class
- Inheritance
-
- Object
- NativeClass
- ByteRTCMixedStreamLayoutRegionConfig
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
alpha
↔ FutureOr<CGFloat?>
-
@brief 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<ByteRTCMixedStreamAlternateImageFillMode?>
-
@valid since 3.57
@brief Sets the fill mode of the placeholder image.
This parameter 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. See ByteRTCMixedStreamAlternateImageFillMode{@link #ByteRTCMixedStreamAlternateImageFillMode}.
getter/setter pair
-
alternateImageUrl
↔ FutureOr<NSString?>
-
@valid since 3.57
@brief Sets the URL of the placeholder image, limited to a maximum of 1024 characters.
getter/setter pair
-
applySpatialAudio
↔ FutureOr<BOOL?>
-
@brief Sets whether a user applies spatial audio effects:
- Yes: Yes (default setting)
- No: No
getter/setter pair
-
cornerRadius
↔ FutureOr<CGFloat?>
-
@brief The proportion of the radius to the width of the canvas.
0.0 by default.
After you set the value, width_px, height_px, and cornerRadius_px are calculated based on width, height, cornerRadius, and the width of the canvas. If cornerRadius_px < min(width_px/2, height_px/2) is met, the value of cornerRadius is set valid; if not, cornerRadius_px is set to min(width_px/2, height_px/2), and cornerRadius is set to the proportion of cornerRadius_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<NSInteger?>
-
@brief The heigh of the user's frame in pixels. The value range is
0, the height of the canvas. The default value is 640.
getter/setter pair
-
imageWaterMark
↔ FutureOr<NSData?>
-
@brief The RGBA data of the watermark. It is required when the
regionContentType is set to ByteRTCMixedStreamLayoutRegionTypeImage.
Put in null when you choose ByteRTCMixedStreamLayoutRegionTypeVideoStream as regionContentType.
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
imageWaterMarkConfig
↔ FutureOr<ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig?>
-
@brief The resolution of the watermark. It is required when the
regionContentType is set to ByteRTCMixedStreamLayoutRegionTypeImage. See ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig{@link #ByteRTCMixedStreamLayoutRegionImageWaterMarkConfig}.
Put in null when you choose ByteRTCMixedStreamLayoutRegionTypeVideoStream as regionContentType.
This parameter is not supported for WTN stream tasks.
getter/setter pair
-
isLocalUser
↔ FutureOr<BOOL?>
-
getter/setter pair
-
locationX
↔ FutureOr<NSInteger?>
-
@brief 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.
The value range is [0, the width of the canvas). The default value is 0.
getter/setter pair
-
locationY
↔ FutureOr<NSInteger?>
-
@brief 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.
The value range is [0, the height of the canvas). The default value is 0.
getter/setter pair
-
mediaType
↔ FutureOr<ByteRTCMixedStreamMediaType?>
-
@brief The stream mixing content type. The default value is
ByteRTCTranscoderContentControlTypeHasAudioAndVideo. See ByteRTCMixedStreamMediaType{@link #ByteRTCMixedStreamMediaType}.
getter/setter pair
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
regionContentType
↔ FutureOr<ByteRTCMixedStreamLayoutRegionType?>
-
@brief Stream mixing region type. See ByteRTCMixedStreamLayoutRegionType{@link #ByteRTCMixedStreamLayoutRegionType}. It's recommended to be set.
getter/setter pair
-
renderMode
↔ FutureOr<ByteRTCMixedStreamRenderMode?>
-
@brief The render mode. See ByteRTCMixedStreamRenderMode{@link #ByteRTCMixedStreamRenderMode}. The default value is 1.
getter/setter pair
-
roomID
↔ FutureOr<NSString?>
-
@brief The room ID of the media stream. It's recommended to be set.
If the media stream is the stream forwarded by startForwardStreamToRooms:{@link #ByteRTCRoom#startForwardStreamToRooms}, you must set the roomID to the room ID of the target room.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceCrop
↔ FutureOr<ByteRTCSourceCropInfo?>
-
@brief Crop the stream before merge into the WTN stream. See ByteRTCSourceCropInfo{@link #ByteRTCSourceCropInfo}.
getter/setter pair
-
spatialPosition
↔ FutureOr<ByteRTCPosition?>
-
@brief spatial position. See ByteRTCPosition{@link #ByteRTCPosition}.
getter/setter pair
-
streamType
↔ FutureOr<ByteRTCMixedStreamVideoType?>
-
getter/setter pair
-
userID
↔ FutureOr<NSString?>
-
@brief The user ID of the user who publishes the video stream. It's recommended to be set.
getter/setter pair
-
width
↔ FutureOr<NSInteger?>
-
@brief The width of the user's frame in pixels. The value range is
0, the width of the canvas. The default value is 360.
getter/setter pair
-
zOrder
↔ FutureOr<NSInteger?>
-
@brief The layer on which the video is rendered. The range is
0, 100. 0 for the bottom layer, and 100 for the top layer. The default value is 0. It's recommended to be set.
getter/setter pair
