ByteRTCMixedStreamControlConfig class
- Inheritance
-
- Object
- NativeClass
- ByteRTCMixedStreamControlConfig
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
enableVolumeIndication
↔ FutureOr<BOOL?>
-
@valid since 3.56
@brief Sets whether to enable the function of separately sending sound indication SEI:
- True: Enable.
- False: Disable. Default setting.
After setting this parameter to "true", you can choose whether to send sound indication SEI only through ByteRTCMixedStreamControlConfig.seiContentMode.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isAddVolumeValue
↔ FutureOr<BOOL?>
-
@valid since 3.56
@brief Sets whether volume value is contained in the sound indication SEI:
- True: Yes.
- False: No. Default setting.
getter/setter pair
-
mediaType
↔ FutureOr<ByteRTCMixedStreamMediaType?>
-
@valid since 3.57
@brief Sets the type of media stream pushed to CDN after being mixed. ByteRTCMixedStreamMediaType{@link #ByteRTCMixedStreamMediaType}.
The default value is 0，which means pushing both audio and video.
getter/setter pair
-
pushStreamMode
↔ FutureOr<ByteRTCMixedStreamPushMode?>
-
@valid since 3.57
@brief Sets whether to initiate a stream mixing task in the absence of any users publishing streams. See ByteRTCMixedStreamPushMode{@link #ByteRTCMixedStreamPushMode}.
Once the stream mixing task is initiated, this parameter can not be updated any more.
getter/setter pair
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
seiContentMode
↔ FutureOr<ByteRTCMixedStreamSEIContentMode?>
-
@valid since 3.56
@brief Sets SEI content. See ByteRTCMixedStreamSEIContentMode{@link #ByteRTCMixedStreamSEIContentMode}.
getter/setter pair
-
seiPayloadType
↔ FutureOr<NSInteger?>
-
@valid since 3.56
@brief SEI payload type.
The default value is 100, and the value supported is 5 and 100.
During the process of pushing streams to CDN, you cannot change the parameter.
getter/setter pair
-
seiPayloadUUID
↔ FutureOr<NSString?>
-
@valid since 3.56
@brief SEI payload UUID.
@note When PayloadType is
5, you must set PayloadUUID, or you will receive a callback indicating parameter error. The error code is 1091.
When PayloadType is not 5, it is not required to set PayloadUUID. If filled, it will be ignored by the backend.
The length of PayloadUUID should be 32 bits, or you will receive an error code of 1091.
Each character of the parameter should be within the range of 0, 9 a, f A, F.
The PayloadUUID should not contain -. If the automatically generated UUID contains -, you should delete it.
During the process of pushing streams to CDN, you cannot change the parameter.
getter/setter pair
-
talkVolume
↔ FutureOr<NSInteger?>
-
@valid since 3.56
@brief Effective volume within the range of
0, 255. The default value is 0.
If the value is set beyond the range, it will be automatically adjusted to the default value 0.
getter/setter pair
-
volumeIndicationInterval
↔ FutureOr<CGFloat?>
-
@valid since 3.56
@brief Sound indication interval in s. The range is [0.3,+∞). The default value is 2.
If a decimal with two or more decimal places is passed in, it will be rounded to the value of the first decimal place. For example, if you pass in 0.36, it will be automatically adjusted to 0.4.
getter/setter pair
