MixedStreamControlConfig class
- Inheritance
-
- Object
- NativeClass
- MixedStreamControlConfig
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
enableVolumeIndication
↔ FutureOr<boolean?>
-
@valid since 3.56
@detail api
@brief Sets whether to enable the function of separately sending sound indication SEI.
@param enableVolumeIndication Whether to enable the function of separately sending sound indication SEI:
- true: Enable.
- false: Disable. Default setting.
@note After setting this method to "true", you can choose whether to send sound indication SEI only through seiContentMode{@link #MixedStreamControlConfig#seiContentMode}.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
isAddVolumeValue
↔ FutureOr<boolean?>
-
@valid since 3.56
@brief Sets whether volume value is contained in the sound indication SEI.
@param addVolumeValue Whether volume value is contained in the sound indication SEI:
- true: Yes.
- false: No. Default setting.
getter/setter pair
-
mediaType
↔ FutureOr<MixedStreamMediaType?>
-
@valid since 3.57
@detail api
@brief Sets the type of media stream pushed to CDN after being mixed.
@param mediaType See MixedStreamMediaType{@link #MixedStreamMediaType}.
The default value is 0，which means pushing both audio and video. Pushing video only is not supported currently.
getter/setter pair
-
pushStreamMode
↔ FutureOr<MixedStreamPushMode?>
-
@valid since 3.57
@detail api
@brief Sets whether to initiate a stream mixing task in the absence of any users publishing streams.
@param pushStreamMode The initiation mode. See MixedStreamPushMode{@link #MixedStreamPushMode}.
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<MixedStreamSEIContentMode?>
-
@valid since 3.56
@detail api
@brief Sets SEI content.
@param seiContentMode SEI content. See MixedStreamSEIContentMode{@link #MixedStreamSEIContentMode}.
getter/setter pair
-
seiPayloadType
↔ FutureOr<int?>
-
@valid since 3.56
@detail api
@author liujingchao
@brief Set SEI payload type.
@param seiPayloadType The default value is
100, and the value supported is 5 and 100.
@return MixedStreamControlConfig, See MixedStreamControlConfig{@link# MixedStreamControlConfig}.
@note During the process of pushing streams to CDN, you cannot change the parameter.
getter/setter pair
-
seiPayloadUuid
↔ FutureOr<String?>
-
@valid since 3.56
@detail api
@author liujingchao
@brief Set SEI Payload UUID.
@param seiPayloadUuid 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.
@return MixedStreamControlConfig, See MixedStreamControlConfig{@link# MixedStreamControlConfig}.
@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.
During the process of pushing streams to CDN, you cannot change the parameter.
getter/setter pair
-
talkVolume
↔ FutureOr<int?>
-
@detail api
@brief Sets the effective volume.
@param talkVolume Effective volume. The range is
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<float?>
-
@valid since 3.56
@detail api
@brief Sets the sound indication interval.
@param volumeIndicationInterval 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
