RtmpStreamPublishState enum

States of the Media Push.

Inheritance

• Object
• Enum
• RtmpStreamPublishState

Annotations

• @JsonEnum(alwaysCreate: true)

Constructors

RtmpStreamPublishState()

const

Values

rtmpStreamPublishStateIdle → const RtmpStreamPublishState

0: The Media Push has not started or has ended.

rtmpStreamPublishStateConnecting → const RtmpStreamPublishState

1: The streaming server and CDN server are being connected.

rtmpStreamPublishStateRunning → const RtmpStreamPublishState

2: The RTMP or RTMPS streaming publishes. The SDK successfully publishes the RTMP or RTMPS streaming and returns this state.

rtmpStreamPublishStateRecovering → const RtmpStreamPublishState

3: The RTMP or RTMPS streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK tries to resume RTMP or RTMPS streaming and returns this state. If the SDK successfully resumes the streaming, rtmpStreamPublishStateRunning (2) returns. If the streaming does not resume within 60 seconds or server errors occur, rtmpStreamPublishStateFailure (4) returns. If you feel that 60 seconds is too long, you can also actively try to reconnect.

rtmpStreamPublishStateFailure → const RtmpStreamPublishState

4: The RTMP or RTMPS streaming fails. After a failure, you can troubleshoot the cause of the error through the returned error code.

rtmpStreamPublishStateDisconnecting → const RtmpStreamPublishState

5: The SDK is disconnecting from the Agora streaming server and CDN. When you call stopRtmpStream to stop the Media Push normally, the SDK reports the Media Push state as rtmpStreamPublishStateDisconnecting and rtmpStreamPublishStateIdle in sequence.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Constants

values → const List<RtmpStreamPublishState>

A constant List of the values in this enum, in order of their declaration.