pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin.outputs/GetStreamResult

GetStreamResult

data class GetStreamResult(val accountId: String, val allowedOrigins: List<String>, val created: String, val creator: String, val duration: Double, val id: String, val identifier: String, val input: GetStreamInput, val liveInput: String, val maxDurationSeconds: Int, val meta: String, val modified: String, val playback: GetStreamPlayback, val preview: String, val readyToStream: Boolean, val readyToStreamAt: String, val requireSignedUrls: Boolean, val scheduledDeletion: String, val size: Double, val status: GetStreamStatus, val thumbnail: String, val thumbnailTimestampPct: Double, val uid: String, val uploadExpiry: String, val uploaded: String, val watermark: GetStreamWatermark)

A collection of values returned by getStream.

Constructors

Link copied to clipboard
constructor(accountId: String, allowedOrigins: List<String>, created: String, creator: String, duration: Double, id: String, identifier: String, input: GetStreamInput, liveInput: String, maxDurationSeconds: Int, meta: String, modified: String, playback: GetStreamPlayback, preview: String, readyToStream: Boolean, readyToStreamAt: String, requireSignedUrls: Boolean, scheduledDeletion: String, size: Double, status: GetStreamStatus, thumbnail: String, thumbnailTimestampPct: Double, uid: String, uploadExpiry: String, uploaded: String, watermark: GetStreamWatermark)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val accountId: String

The account identifier tag.

Link copied to clipboard
val allowedOrigins: List<String>

Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

Link copied to clipboard
val created: String

The date and time the media item was created.

Link copied to clipboard
val creator: String

A user-defined identifier for the media creator.

Link copied to clipboard
val duration: Double

The duration of the video in seconds. A value of -1 means the duration is unknown. The duration becomes available after the upload and before the video is ready.

Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
val identifier: String

A Cloudflare-generated unique identifier for a media item.

Link copied to clipboard
Link copied to clipboard
val liveInput: String

The live input ID used to upload a video with Stream Live.

Link copied to clipboard
val maxDurationSeconds: Int

The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

Link copied to clipboard
val meta: String

A user modifiable key-value store used to reference other systems of record for managing videos.

Link copied to clipboard
val modified: String

The date and time the media item was last modified.

Link copied to clipboard
Link copied to clipboard
val preview: String

The video's preview page URI. This field is omitted until encoding is complete.

Link copied to clipboard
val readyToStream: Boolean

Indicates whether the video is playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.

Link copied to clipboard
val readyToStreamAt: String

Indicates the time at which the video became playable. The field is empty if the video is not ready for viewing or the live stream is still in progress.

Link copied to clipboard
val requireSignedUrls: Boolean

Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.

Link copied to clipboard
val scheduledDeletion: String

Indicates the date and time at which the video will be deleted. Omit the field to indicate no change, or include with a null value to remove an existing scheduled deletion. If specified, must be at least 30 days from upload time.

Link copied to clipboard
val size: Double

The size of the media item in bytes.

Link copied to clipboard
val status: GetStreamStatus

Specifies a detailed status for a video. If the state is inprogress or error, the step field returns encoding or manifest. If the state is inprogress, pctComplete returns a number between 0 and 100 to indicate the approximate percent of completion. If the state is error, errorReasonCode and errorReasonText provide additional details.

Link copied to clipboard
val thumbnail: String

The media item's thumbnail URI. This field is omitted until encoding is complete.

Link copied to clipboard
val thumbnailTimestampPct: Double

The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

Link copied to clipboard
val uid: String

A Cloudflare-generated unique identifier for a media item.

Link copied to clipboard
val uploaded: String

The date and time the media item was uploaded.

Link copied to clipboard
val uploadExpiry: String

The date and time when the video upload URL is no longer valid for direct user uploads.

Link copied to clipboard