Module Values.ChannelSummarySource

Summary information about a channel.

Sourcetype nonrec t = {
  1. arn : ChannelArn.t option;
    (*

    Channel ARN.

    *)
  2. name : ChannelName.t option;
    (*

    Channel name.

    *)
  3. latencyMode : ChannelLatencyMode.t option;
    (*

    Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

    *)
  4. authorized : IsAuthorized.t option;
    (*

    Whether the channel is private (enabled for playback authorization). Default: false.

    *)
  5. recordingConfigurationArn : ChannelRecordingConfigurationArn.t option;
    (*

    Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

    *)
  6. tags : Tags.t option;
    (*

    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

    *)
  7. insecureIngest : InsecureIngest.t option;
    (*

    Whether the channel allows insecure RTMP ingest. Default: false.

    *)
  8. type_ : ChannelType.t option;
    (*

    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

    *)
  9. preset : TranscodePreset.t option;
    (*

    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

    *)
  10. playbackRestrictionPolicyArn : ChannelPlaybackRestrictionPolicyArn.t option;
    (*

    Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

    *)
  11. adConfigurationArn : ChannelAdConfigurationArn.t option;
    (*

    ARN of the ad configuration associated with the channel.

    *)
}
Sourceval make : ?arn:??? -> ?name:??? -> ?latencyMode:??? -> ?authorized:??? -> ?recordingConfigurationArn:??? -> ?tags:??? -> ?insecureIngest:??? -> ?type_:??? -> ?preset:??? -> ?playbackRestrictionPolicyArn:??? -> ?adConfigurationArn:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of IsAuthorized.t | `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of ChannelArn.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t