Type Alias StreamInfo

StreamInfo: ApiPaged & {
    alternates?: StreamAlternate[];
    cluster?: ClusterInfo;
    config: StreamConfig;
    created: string;
    mirror?: StreamSourceInfo;
    sources?: StreamSourceInfo[];
    state: StreamState;
    ts?: string;
}

Stream configuration info

Type declaration

  • Optionalalternates?: StreamAlternate[]

    Alternates for a stream if applicable. Alternates are listed in order of TTL. With streams at the start of the Array potentially closer and faster to access.

  • Optionalcluster?: ClusterInfo

    Cluster information for the stream if applicable

  • config: StreamConfig

    The active configuration for the Stream

  • created: string

    The ISO Timestamp when the stream was created

  • Optionalmirror?: StreamSourceInfo

    Information about an upstream stream source in a mirror

  • Optionalsources?: StreamSourceInfo[]

    Sources for the Stream if applicable

  • state: StreamState

    Detail about the current State of the Stream

  • Optionalts?: string

    The ISO timestamp when the StreamInfo was generated. This field is only available on servers 2.10.x or better