Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
cloudflare.getStream
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleStream = cloudflare.getStream({
accountId: "023e105f4ecef8ad9ca31a8372d0c353",
identifier: "ea95132c15732412d22c1476fa83f27a",
});
import pulumi
import pulumi_cloudflare as cloudflare
example_stream = cloudflare.get_stream(account_id="023e105f4ecef8ad9ca31a8372d0c353",
identifier="ea95132c15732412d22c1476fa83f27a")
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.LookupStream(ctx, &cloudflare.LookupStreamArgs{
AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
Identifier: "ea95132c15732412d22c1476fa83f27a",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var exampleStream = Cloudflare.GetStream.Invoke(new()
{
AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
Identifier = "ea95132c15732412d22c1476fa83f27a",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetStreamArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var exampleStream = CloudflareFunctions.getStream(GetStreamArgs.builder()
.accountId("023e105f4ecef8ad9ca31a8372d0c353")
.identifier("ea95132c15732412d22c1476fa83f27a")
.build());
}
}
variables:
exampleStream:
fn::invoke:
function: cloudflare:getStream
arguments:
accountId: 023e105f4ecef8ad9ca31a8372d0c353
identifier: ea95132c15732412d22c1476fa83f27a
Using getStream
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>
function getStreamOutput(args: GetStreamOutputArgs, opts?: InvokeOptions): Output<GetStreamResult>
def get_stream(account_id: Optional[str] = None,
identifier: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamResult
def get_stream_output(account_id: Optional[pulumi.Input[str]] = None,
identifier: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamResult]
func LookupStream(ctx *Context, args *LookupStreamArgs, opts ...InvokeOption) (*LookupStreamResult, error)
func LookupStreamOutput(ctx *Context, args *LookupStreamOutputArgs, opts ...InvokeOption) LookupStreamResultOutput
> Note: This function is named LookupStream
in the Go SDK.
public static class GetStream
{
public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
public static Output<GetStreamResult> Invoke(GetStreamInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
public static Output<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
fn::invoke:
function: cloudflare:index/getStream:getStream
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Id string - The account identifier tag.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Account
Id string - The account identifier tag.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- account
Id String - The account identifier tag.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
- account
Id string - The account identifier tag.
- identifier string
- A Cloudflare-generated unique identifier for a media item.
- account_
id str - The account identifier tag.
- identifier str
- A Cloudflare-generated unique identifier for a media item.
- account
Id String - The account identifier tag.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
getStream Result
The following output properties are available:
- Account
Id string - The account identifier tag.
- Allowed
Origins 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. - Created string
- The date and time the media item was created.
- Creator string
- A user-defined identifier for the media creator.
- 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Input
Get
Stream Input - Live
Input string - The live input ID used to upload a video with Stream Live.
- Max
Duration intSeconds - 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. - Meta string
- A user modifiable key-value store used to reference other systems of record for managing videos.
- Modified string
- The date and time the media item was last modified.
- Playback
Get
Stream Playback - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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.
- Ready
To stringStream At - 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.
- Require
Signed boolUrls - 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. - Scheduled
Deletion 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. - Size double
- The size of the media item in bytes.
- Status
Get
Stream Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Thumbnail
Timestamp doublePct - 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.
- Uid string
- A Cloudflare-generated unique identifier for a media item.
- Upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- Uploaded string
- The date and time the media item was uploaded.
- Watermark
Get
Stream Watermark
- Account
Id string - The account identifier tag.
- Allowed
Origins []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. - Created string
- The date and time the media item was created.
- Creator string
- A user-defined identifier for the media creator.
- Duration float64
- 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Identifier string
- A Cloudflare-generated unique identifier for a media item.
- Input
Get
Stream Input - Live
Input string - The live input ID used to upload a video with Stream Live.
- Max
Duration intSeconds - 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. - Meta string
- A user modifiable key-value store used to reference other systems of record for managing videos.
- Modified string
- The date and time the media item was last modified.
- Playback
Get
Stream Playback - Preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- Ready
To boolStream - 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.
- Ready
To stringStream At - 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.
- Require
Signed boolUrls - 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. - Scheduled
Deletion 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. - Size float64
- The size of the media item in bytes.
- Status
Get
Stream Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - Thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- Thumbnail
Timestamp float64Pct - 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.
- Uid string
- A Cloudflare-generated unique identifier for a media item.
- Upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- Uploaded string
- The date and time the media item was uploaded.
- Watermark
Get
Stream Watermark Type
- account
Id String - The account identifier tag.
- allowed
Origins 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. - created String
- The date and time the media item was created.
- creator String
- A user-defined identifier for the media creator.
- 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. - id String
- The provider-assigned unique ID for this managed resource.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
- input
Get
Stream Input - live
Input String - The live input ID used to upload a video with Stream Live.
- max
Duration IntegerSeconds - 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. - meta String
- A user modifiable key-value store used to reference other systems of record for managing videos.
- modified String
- The date and time the media item was last modified.
- playback
Get
Stream Playback - preview String
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To BooleanStream - 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.
- ready
To StringStream At - 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.
- require
Signed BooleanUrls - 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. - scheduled
Deletion 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. - size Double
- The size of the media item in bytes.
- status
Get
Stream Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp DoublePct - 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.
- uid String
- A Cloudflare-generated unique identifier for a media item.
- upload
Expiry String - The date and time when the video upload URL is no longer valid for direct user uploads.
- uploaded String
- The date and time the media item was uploaded.
- watermark
Get
Stream Watermark
- account
Id string - The account identifier tag.
- allowed
Origins 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. - created string
- The date and time the media item was created.
- creator string
- A user-defined identifier for the media creator.
- duration number
- 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. - id string
- The provider-assigned unique ID for this managed resource.
- identifier string
- A Cloudflare-generated unique identifier for a media item.
- input
Get
Stream Input - live
Input string - The live input ID used to upload a video with Stream Live.
- max
Duration numberSeconds - 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. - meta string
- A user modifiable key-value store used to reference other systems of record for managing videos.
- modified string
- The date and time the media item was last modified.
- playback
Get
Stream Playback - preview string
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To booleanStream - 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.
- ready
To stringStream At - 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.
- require
Signed booleanUrls - 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. - scheduled
Deletion 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. - size number
- The size of the media item in bytes.
- status
Get
Stream Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail string
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp numberPct - 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.
- uid string
- A Cloudflare-generated unique identifier for a media item.
- upload
Expiry string - The date and time when the video upload URL is no longer valid for direct user uploads.
- uploaded string
- The date and time the media item was uploaded.
- watermark
Get
Stream Watermark
- account_
id str - The account identifier tag.
- allowed_
origins Sequence[str] - 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. - created str
- The date and time the media item was created.
- creator str
- A user-defined identifier for the media creator.
- duration float
- 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. - id str
- The provider-assigned unique ID for this managed resource.
- identifier str
- A Cloudflare-generated unique identifier for a media item.
- input
Get
Stream Input - live_
input str - The live input ID used to upload a video with Stream Live.
- max_
duration_ intseconds - 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. - meta str
- A user modifiable key-value store used to reference other systems of record for managing videos.
- modified str
- The date and time the media item was last modified.
- playback
Get
Stream Playback - preview str
- The video's preview page URI. This field is omitted until encoding is complete.
- ready_
to_ boolstream - 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.
- ready_
to_ strstream_ at - 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.
- require_
signed_ boolurls - 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. - scheduled_
deletion str - 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. - size float
- The size of the media item in bytes.
- status
Get
Stream Status - Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail str
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail_
timestamp_ floatpct - 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.
- uid str
- A Cloudflare-generated unique identifier for a media item.
- upload_
expiry str - The date and time when the video upload URL is no longer valid for direct user uploads.
- uploaded str
- The date and time the media item was uploaded.
- watermark
Get
Stream Watermark
- account
Id String - The account identifier tag.
- allowed
Origins 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. - created String
- The date and time the media item was created.
- creator String
- A user-defined identifier for the media creator.
- duration Number
- 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. - id String
- The provider-assigned unique ID for this managed resource.
- identifier String
- A Cloudflare-generated unique identifier for a media item.
- input Property Map
- live
Input String - The live input ID used to upload a video with Stream Live.
- max
Duration NumberSeconds - 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. - meta String
- A user modifiable key-value store used to reference other systems of record for managing videos.
- modified String
- The date and time the media item was last modified.
- playback Property Map
- preview String
- The video's preview page URI. This field is omitted until encoding is complete.
- ready
To BooleanStream - 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.
- ready
To StringStream At - 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.
- require
Signed BooleanUrls - 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. - scheduled
Deletion 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. - size Number
- The size of the media item in bytes.
- status Property Map
- Specifies a detailed status for a video. If the
state
isinprogress
orerror
, thestep
field returnsencoding
ormanifest
. If thestate
isinprogress
,pctComplete
returns a number between 0 and 100 to indicate the approximate percent of completion. If thestate
iserror
,errorReasonCode
anderrorReasonText
provide additional details. - thumbnail String
- The media item's thumbnail URI. This field is omitted until encoding is complete.
- thumbnail
Timestamp NumberPct - 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.
- uid String
- A Cloudflare-generated unique identifier for a media item.
- upload
Expiry String - The date and time when the video upload URL is no longer valid for direct user uploads.
- uploaded String
- The date and time the media item was uploaded.
- watermark Property Map
Supporting Types
GetStreamInput
- Height int
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - Width int
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
- Height int
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - Width int
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
- height Integer
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - width Integer
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
- height number
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - width number
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
- height int
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - width int
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
- height Number
- The video height in pixels. A value of
-1
means the height is unknown. The value becomes available after the upload and before the video is ready. - width Number
- The video width in pixels. A value of
-1
means the width is unknown. The value becomes available after the upload and before the video is ready.
GetStreamPlayback
GetStreamStatus
- Error
Reason stringCode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - Error
Reason stringText - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - Pct
Complete string - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- State string
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
- Error
Reason stringCode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - Error
Reason stringText - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - Pct
Complete string - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- State string
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
- error
Reason StringCode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - error
Reason StringText - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - pct
Complete String - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- state String
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
- error
Reason stringCode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - error
Reason stringText - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - pct
Complete string - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- state string
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
- error_
reason_ strcode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - error_
reason_ strtext - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - pct_
complete str - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- state str
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
- error
Reason StringCode - Specifies why the video failed to encode. This field is empty if the video is not in an
error
state. Preferred for programmatic use. - error
Reason StringText - Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an
error
state. - pct
Complete String - Indicates the size of the entire upload in bytes. The value must be a non-negative integer.
- state String
- Specifies the processing status for all quality levels for a video. Available values: "pendingupload", "downloading", "queued", "inprogress", "ready", "error".
GetStreamWatermark
- Created string
- The date and a time a watermark profile was created.
- Downloaded
From string - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- Height int
- The height of the image in pixels.
- Name string
- A short description of the watermark profile.
- Opacity double
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - Padding double
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - Position string
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - Scale double
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - Size double
- The size of the image in bytes.
- Uid string
- The unique identifier for a watermark profile.
- Width int
- The width of the image in pixels.
- Created string
- The date and a time a watermark profile was created.
- Downloaded
From string - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- Height int
- The height of the image in pixels.
- Name string
- A short description of the watermark profile.
- Opacity float64
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - Padding float64
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - Position string
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - Scale float64
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - Size float64
- The size of the image in bytes.
- Uid string
- The unique identifier for a watermark profile.
- Width int
- The width of the image in pixels.
- created String
- The date and a time a watermark profile was created.
- downloaded
From String - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- height Integer
- The height of the image in pixels.
- name String
- A short description of the watermark profile.
- opacity Double
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - padding Double
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - position String
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - scale Double
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - size Double
- The size of the image in bytes.
- uid String
- The unique identifier for a watermark profile.
- width Integer
- The width of the image in pixels.
- created string
- The date and a time a watermark profile was created.
- downloaded
From string - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- height number
- The height of the image in pixels.
- name string
- A short description of the watermark profile.
- opacity number
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - padding number
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - position string
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - scale number
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - size number
- The size of the image in bytes.
- uid string
- The unique identifier for a watermark profile.
- width number
- The width of the image in pixels.
- created str
- The date and a time a watermark profile was created.
- downloaded_
from str - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- height int
- The height of the image in pixels.
- name str
- A short description of the watermark profile.
- opacity float
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - padding float
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - position str
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - scale float
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - size float
- The size of the image in bytes.
- uid str
- The unique identifier for a watermark profile.
- width int
- The width of the image in pixels.
- created String
- The date and a time a watermark profile was created.
- downloaded
From String - The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.
- height Number
- The height of the image in pixels.
- name String
- A short description of the watermark profile.
- opacity Number
- The translucency of the image. A value of
0.0
makes the image completely transparent, and1.0
makes the image completely opaque. Note that if the image is already semi-transparent, setting this to1.0
will not make the image completely opaque. - padding Number
- The whitespace between the adjacent edges (determined by position) of the video and the image.
0.0
indicates no padding, and1.0
indicates a fully padded video width or length, as determined by the algorithm. - position String
- The location of the image. Valid positions are:
upperRight
,upperLeft
,lowerLeft
,lowerRight
, andcenter
. Note thatcenter
ignores thepadding
parameter. - scale Number
- The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically.
0.0
indicates no scaling (use the size of the image as-is), and1.0
fills the entire video. - size Number
- The size of the image in bytes.
- uid String
- The unique identifier for a watermark profile.
- width Number
- The width of the image in pixels.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflare
Terraform Provider.