Documentation
¶
Index ¶
- type Caster
- type CasterArgs
- type CasterArray
- type CasterArrayInput
- type CasterArrayOutput
- type CasterInput
- type CasterMap
- type CasterMapInput
- type CasterMapOutput
- type CasterOutput
- func (o CasterOutput) AutoSwitchUrgentConfig() pulumi.StringPtrOutput
- func (o CasterOutput) AutoSwitchUrgentOn() pulumi.BoolPtrOutput
- func (o CasterOutput) CallbackUrl() pulumi.StringPtrOutput
- func (o CasterOutput) CasterName() pulumi.StringPtrOutput
- func (o CasterOutput) CreateTime() pulumi.StringOutput
- func (o CasterOutput) Delay() pulumi.Float64PtrOutput
- func (o CasterOutput) DomainName() pulumi.StringPtrOutput
- func (CasterOutput) ElementType() reflect.Type
- func (o CasterOutput) NormType() pulumi.IntOutput
- func (o CasterOutput) PaymentType() pulumi.StringOutput
- func (o CasterOutput) ProgramEffect() pulumi.IntPtrOutput
- func (o CasterOutput) ProgramName() pulumi.StringPtrOutput
- func (o CasterOutput) RecordConfig() pulumi.StringPtrOutput
- func (o CasterOutput) ResourceGroupId() pulumi.StringOutput
- func (o CasterOutput) ResourceType() pulumi.StringPtrOutput
- func (o CasterOutput) SideOutputUrl() pulumi.StringPtrOutput
- func (o CasterOutput) SideOutputUrlList() pulumi.StringPtrOutput
- func (o CasterOutput) SyncGroupsConfig() pulumi.StringPtrOutput
- func (o CasterOutput) Tags() pulumi.StringMapOutput
- func (o CasterOutput) ToCasterOutput() CasterOutput
- func (o CasterOutput) ToCasterOutputWithContext(ctx context.Context) CasterOutput
- func (o CasterOutput) TranscodeConfig() pulumi.StringPtrOutput
- func (o CasterOutput) UrgentImageId() pulumi.StringPtrOutput
- func (o CasterOutput) UrgentImageUrl() pulumi.StringPtrOutput
- func (o CasterOutput) UrgentLiveStreamUrl() pulumi.StringPtrOutput
- func (o CasterOutput) UrgentMaterialId() pulumi.StringPtrOutput
- type CasterState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Caster ¶
type Caster struct { pulumi.CustomResourceState // Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds. AutoSwitchUrgentConfig pulumi.StringPtrOutput `pulumi:"autoSwitchUrgentConfig"` // Turn on the cut-off automatic switch for broadcast preparation. // // true: open. // // false: closed. AutoSwitchUrgentOn pulumi.BoolPtrOutput `pulumi:"autoSwitchUrgentOn"` // The callback address of the user. To receive Callback Notifications, enter an available address and accept the HTTP protocol. If this parameter is set to null, the callback notification from the director Station is canceled by default. CallbackUrl pulumi.StringPtrOutput `pulumi:"callbackUrl"` // Guide station name. CasterName pulumi.StringPtrOutput `pulumi:"casterName"` // Creation time. CreateTime pulumi.StringOutput `pulumi:"createTime"` // Delayed playback. Time unit: seconds. Delay pulumi.Float64PtrOutput `pulumi:"delay"` // Master play domain name. DomainName pulumi.StringPtrOutput `pulumi:"domainName"` // Guide station specification type. Value: // - 0: Broadcast single type. // - 1: General purpose. NormType pulumi.IntOutput `pulumi:"normType"` // The paymen type of the resource PaymentType pulumi.StringOutput `pulumi:"paymentType"` // Carousel effective flag. // // 0: Not in effect. // // 1: Entry into force. ProgramEffect pulumi.IntPtrOutput `pulumi:"programEffect"` // The carousel station name, which can be configured when using the carousel function. ProgramName pulumi.StringPtrOutput `pulumi:"programName"` // Record configuration information. The format is JSON. The configuration element information is as follows: RecordConfig pulumi.StringPtrOutput `pulumi:"recordConfig"` // Resource Group id ResourceGroupId pulumi.StringOutput `pulumi:"resourceGroupId"` // resource type ResourceType pulumi.StringPtrOutput `pulumi:"resourceType"` // The user-defined stream ingest address corresponding to the bypass output address of the guide station. If this parameter is left blank, the streaming address corresponding to the output address automatically generated by Alibaba Cloud is used by default. SideOutputUrl pulumi.StringPtrOutput `pulumi:"sideOutputUrl"` // The list of multiple forwarding stream addresses, which can be the CDN forwarding stream addresses of Alibaba Cloud or a third-party vendor. A guide can add up to 20 RTMP forwarding addresses. SideOutputUrlList pulumi.StringPtrOutput `pulumi:"sideOutputUrlList"` // Multi-View synchronization configuration to synchronize multiple video sources. Multi-View synchronization is divided into two modes: // - `mode 0`: (In the anchor mode, multiple video sources are synchronized according to the specified mode.) // - `mode 1`: (Conference mode, there is no concept of anchor video, all video sources are synchronized with each other.) // - `Anchor mode`: hostResourceId: the video source of the anchor in Anchor mode. // - `Conference mode`: no hostRsoureId field, only the resource ids in the resourceIds to be provided. SyncGroupsConfig pulumi.StringPtrOutput `pulumi:"syncGroupsConfig"` // The tag of the resource Tags pulumi.StringMapOutput `pulumi:"tags"` // Transcoding configuration. // // JSON format string, Please capitalize the first letter of the internal field of the structure, hump format input. If this parameter is set to null, the transcoding configuration is cleared by default. If the transcoding template is null, an error is reported when the director starts. TranscodeConfig pulumi.StringPtrOutput `pulumi:"transcodeConfig"` // The ID of the picture material of the media library. UrgentImageId pulumi.StringPtrOutput `pulumi:"urgentImageId"` // Prepare the URL of the picture material. UrgentImageUrl pulumi.StringPtrOutput `pulumi:"urgentImageUrl"` // The prepared live stream URL. UrgentLiveStreamUrl pulumi.StringPtrOutput `pulumi:"urgentLiveStreamUrl"` // Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default. UrgentMaterialId pulumi.StringPtrOutput `pulumi:"urgentMaterialId"` }
Provides a Live Caster resource.
Relying on Alibaba Cloud's powerful technologies such as live video broadcasting, media processing, and video AI, cloud guide integrates capabilities such as graphic packaging, real-time keying, multi-language translation, and multi-channel mixed streaming to innovate traditional guide services in the cloud. Provide easy-to-use cloud-based guide services for event performances, news reports, live events, off-site broadcasts and other scenes, without hardware, reduce user guide costs, and create a better live broadcast experience.
For information about Live Caster and how to use it, see [What is Caster](https://www.alibabacloud.com/help/en/).
> **NOTE:** Available since v1.238.0.
## Example Usage
Basic Usage ¶
```go package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/live" "github.com/pulumi/pulumi/sdk/v3/go/pulumi" "github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { cfg := config.New(ctx, "") name := "terraform-example" if param := cfg.Get("name"); param != "" { name = param } _, err := live.NewCaster(ctx, "default", &live.CasterArgs{ CasterName: pulumi.String(name), PaymentType: pulumi.String("PayAsYouGo"), NormType: pulumi.Int(1), }) if err != nil { return err } return nil }) }
```
## Import
Live Caster can be imported using the id, e.g.
```sh $ pulumi import alicloud:live/caster:Caster example <id> ```
func GetCaster ¶
func GetCaster(ctx *pulumi.Context, name string, id pulumi.IDInput, state *CasterState, opts ...pulumi.ResourceOption) (*Caster, error)
GetCaster gets an existing Caster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewCaster ¶
func NewCaster(ctx *pulumi.Context, name string, args *CasterArgs, opts ...pulumi.ResourceOption) (*Caster, error)
NewCaster registers a new resource with the given unique name, arguments, and options.
func (*Caster) ElementType ¶
func (*Caster) ToCasterOutput ¶
func (i *Caster) ToCasterOutput() CasterOutput
func (*Caster) ToCasterOutputWithContext ¶
func (i *Caster) ToCasterOutputWithContext(ctx context.Context) CasterOutput
type CasterArgs ¶
type CasterArgs struct { // Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds. AutoSwitchUrgentConfig pulumi.StringPtrInput // Turn on the cut-off automatic switch for broadcast preparation. // // true: open. // // false: closed. AutoSwitchUrgentOn pulumi.BoolPtrInput // The callback address of the user. To receive Callback Notifications, enter an available address and accept the HTTP protocol. If this parameter is set to null, the callback notification from the director Station is canceled by default. CallbackUrl pulumi.StringPtrInput // Guide station name. CasterName pulumi.StringPtrInput // Delayed playback. Time unit: seconds. Delay pulumi.Float64PtrInput // Master play domain name. DomainName pulumi.StringPtrInput // Guide station specification type. Value: // - 0: Broadcast single type. // - 1: General purpose. NormType pulumi.IntInput // The paymen type of the resource PaymentType pulumi.StringInput // Carousel effective flag. // // 0: Not in effect. // // 1: Entry into force. ProgramEffect pulumi.IntPtrInput // The carousel station name, which can be configured when using the carousel function. ProgramName pulumi.StringPtrInput // Record configuration information. The format is JSON. The configuration element information is as follows: RecordConfig pulumi.StringPtrInput // Resource Group id ResourceGroupId pulumi.StringPtrInput // resource type ResourceType pulumi.StringPtrInput // The user-defined stream ingest address corresponding to the bypass output address of the guide station. If this parameter is left blank, the streaming address corresponding to the output address automatically generated by Alibaba Cloud is used by default. SideOutputUrl pulumi.StringPtrInput // The list of multiple forwarding stream addresses, which can be the CDN forwarding stream addresses of Alibaba Cloud or a third-party vendor. A guide can add up to 20 RTMP forwarding addresses. SideOutputUrlList pulumi.StringPtrInput // Multi-View synchronization configuration to synchronize multiple video sources. Multi-View synchronization is divided into two modes: // - `mode 0`: (In the anchor mode, multiple video sources are synchronized according to the specified mode.) // - `mode 1`: (Conference mode, there is no concept of anchor video, all video sources are synchronized with each other.) // - `Anchor mode`: hostResourceId: the video source of the anchor in Anchor mode. // - `Conference mode`: no hostRsoureId field, only the resource ids in the resourceIds to be provided. SyncGroupsConfig pulumi.StringPtrInput // The tag of the resource Tags pulumi.StringMapInput // Transcoding configuration. // // JSON format string, Please capitalize the first letter of the internal field of the structure, hump format input. If this parameter is set to null, the transcoding configuration is cleared by default. If the transcoding template is null, an error is reported when the director starts. TranscodeConfig pulumi.StringPtrInput // The ID of the picture material of the media library. UrgentImageId pulumi.StringPtrInput // Prepare the URL of the picture material. UrgentImageUrl pulumi.StringPtrInput // The prepared live stream URL. UrgentLiveStreamUrl pulumi.StringPtrInput // Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default. UrgentMaterialId pulumi.StringPtrInput }
The set of arguments for constructing a Caster resource.
func (CasterArgs) ElementType ¶
func (CasterArgs) ElementType() reflect.Type
type CasterArray ¶
type CasterArray []CasterInput
func (CasterArray) ElementType ¶
func (CasterArray) ElementType() reflect.Type
func (CasterArray) ToCasterArrayOutput ¶
func (i CasterArray) ToCasterArrayOutput() CasterArrayOutput
func (CasterArray) ToCasterArrayOutputWithContext ¶
func (i CasterArray) ToCasterArrayOutputWithContext(ctx context.Context) CasterArrayOutput
type CasterArrayInput ¶
type CasterArrayInput interface { pulumi.Input ToCasterArrayOutput() CasterArrayOutput ToCasterArrayOutputWithContext(context.Context) CasterArrayOutput }
CasterArrayInput is an input type that accepts CasterArray and CasterArrayOutput values. You can construct a concrete instance of `CasterArrayInput` via:
CasterArray{ CasterArgs{...} }
type CasterArrayOutput ¶
type CasterArrayOutput struct{ *pulumi.OutputState }
func (CasterArrayOutput) ElementType ¶
func (CasterArrayOutput) ElementType() reflect.Type
func (CasterArrayOutput) Index ¶
func (o CasterArrayOutput) Index(i pulumi.IntInput) CasterOutput
func (CasterArrayOutput) ToCasterArrayOutput ¶
func (o CasterArrayOutput) ToCasterArrayOutput() CasterArrayOutput
func (CasterArrayOutput) ToCasterArrayOutputWithContext ¶
func (o CasterArrayOutput) ToCasterArrayOutputWithContext(ctx context.Context) CasterArrayOutput
type CasterInput ¶
type CasterInput interface { pulumi.Input ToCasterOutput() CasterOutput ToCasterOutputWithContext(ctx context.Context) CasterOutput }
type CasterMap ¶
type CasterMap map[string]CasterInput
func (CasterMap) ElementType ¶
func (CasterMap) ToCasterMapOutput ¶
func (i CasterMap) ToCasterMapOutput() CasterMapOutput
func (CasterMap) ToCasterMapOutputWithContext ¶
func (i CasterMap) ToCasterMapOutputWithContext(ctx context.Context) CasterMapOutput
type CasterMapInput ¶
type CasterMapInput interface { pulumi.Input ToCasterMapOutput() CasterMapOutput ToCasterMapOutputWithContext(context.Context) CasterMapOutput }
CasterMapInput is an input type that accepts CasterMap and CasterMapOutput values. You can construct a concrete instance of `CasterMapInput` via:
CasterMap{ "key": CasterArgs{...} }
type CasterMapOutput ¶
type CasterMapOutput struct{ *pulumi.OutputState }
func (CasterMapOutput) ElementType ¶
func (CasterMapOutput) ElementType() reflect.Type
func (CasterMapOutput) MapIndex ¶
func (o CasterMapOutput) MapIndex(k pulumi.StringInput) CasterOutput
func (CasterMapOutput) ToCasterMapOutput ¶
func (o CasterMapOutput) ToCasterMapOutput() CasterMapOutput
func (CasterMapOutput) ToCasterMapOutputWithContext ¶
func (o CasterMapOutput) ToCasterMapOutputWithContext(ctx context.Context) CasterMapOutput
type CasterOutput ¶
type CasterOutput struct{ *pulumi.OutputState }
func (CasterOutput) AutoSwitchUrgentConfig ¶
func (o CasterOutput) AutoSwitchUrgentConfig() pulumi.StringPtrOutput
Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
func (CasterOutput) AutoSwitchUrgentOn ¶
func (o CasterOutput) AutoSwitchUrgentOn() pulumi.BoolPtrOutput
Turn on the cut-off automatic switch for broadcast preparation.
true: open.
false: closed.
func (CasterOutput) CallbackUrl ¶
func (o CasterOutput) CallbackUrl() pulumi.StringPtrOutput
The callback address of the user. To receive Callback Notifications, enter an available address and accept the HTTP protocol. If this parameter is set to null, the callback notification from the director Station is canceled by default.
func (CasterOutput) CasterName ¶
func (o CasterOutput) CasterName() pulumi.StringPtrOutput
Guide station name.
func (CasterOutput) CreateTime ¶
func (o CasterOutput) CreateTime() pulumi.StringOutput
Creation time.
func (CasterOutput) Delay ¶
func (o CasterOutput) Delay() pulumi.Float64PtrOutput
Delayed playback. Time unit: seconds.
func (CasterOutput) DomainName ¶
func (o CasterOutput) DomainName() pulumi.StringPtrOutput
Master play domain name.
func (CasterOutput) ElementType ¶
func (CasterOutput) ElementType() reflect.Type
func (CasterOutput) NormType ¶
func (o CasterOutput) NormType() pulumi.IntOutput
Guide station specification type. Value: - 0: Broadcast single type. - 1: General purpose.
func (CasterOutput) PaymentType ¶
func (o CasterOutput) PaymentType() pulumi.StringOutput
The paymen type of the resource
func (CasterOutput) ProgramEffect ¶
func (o CasterOutput) ProgramEffect() pulumi.IntPtrOutput
Carousel effective flag.
0: Not in effect.
1: Entry into force.
func (CasterOutput) ProgramName ¶
func (o CasterOutput) ProgramName() pulumi.StringPtrOutput
The carousel station name, which can be configured when using the carousel function.
func (CasterOutput) RecordConfig ¶
func (o CasterOutput) RecordConfig() pulumi.StringPtrOutput
Record configuration information. The format is JSON. The configuration element information is as follows:
func (CasterOutput) ResourceGroupId ¶
func (o CasterOutput) ResourceGroupId() pulumi.StringOutput
Resource Group id
func (CasterOutput) ResourceType ¶
func (o CasterOutput) ResourceType() pulumi.StringPtrOutput
resource type
func (CasterOutput) SideOutputUrl ¶
func (o CasterOutput) SideOutputUrl() pulumi.StringPtrOutput
The user-defined stream ingest address corresponding to the bypass output address of the guide station. If this parameter is left blank, the streaming address corresponding to the output address automatically generated by Alibaba Cloud is used by default.
func (CasterOutput) SideOutputUrlList ¶
func (o CasterOutput) SideOutputUrlList() pulumi.StringPtrOutput
The list of multiple forwarding stream addresses, which can be the CDN forwarding stream addresses of Alibaba Cloud or a third-party vendor. A guide can add up to 20 RTMP forwarding addresses.
func (CasterOutput) SyncGroupsConfig ¶
func (o CasterOutput) SyncGroupsConfig() pulumi.StringPtrOutput
Multi-View synchronization configuration to synchronize multiple video sources. Multi-View synchronization is divided into two modes: - `mode 0`: (In the anchor mode, multiple video sources are synchronized according to the specified mode.) - `mode 1`: (Conference mode, there is no concept of anchor video, all video sources are synchronized with each other.) - `Anchor mode`: hostResourceId: the video source of the anchor in Anchor mode. - `Conference mode`: no hostRsoureId field, only the resource ids in the resourceIds to be provided.
func (CasterOutput) Tags ¶
func (o CasterOutput) Tags() pulumi.StringMapOutput
The tag of the resource
func (CasterOutput) ToCasterOutput ¶
func (o CasterOutput) ToCasterOutput() CasterOutput
func (CasterOutput) ToCasterOutputWithContext ¶
func (o CasterOutput) ToCasterOutputWithContext(ctx context.Context) CasterOutput
func (CasterOutput) TranscodeConfig ¶
func (o CasterOutput) TranscodeConfig() pulumi.StringPtrOutput
Transcoding configuration.
JSON format string, Please capitalize the first letter of the internal field of the structure, hump format input. If this parameter is set to null, the transcoding configuration is cleared by default. If the transcoding template is null, an error is reported when the director starts.
func (CasterOutput) UrgentImageId ¶
func (o CasterOutput) UrgentImageId() pulumi.StringPtrOutput
The ID of the picture material of the media library.
func (CasterOutput) UrgentImageUrl ¶
func (o CasterOutput) UrgentImageUrl() pulumi.StringPtrOutput
Prepare the URL of the picture material.
func (CasterOutput) UrgentLiveStreamUrl ¶
func (o CasterOutput) UrgentLiveStreamUrl() pulumi.StringPtrOutput
The prepared live stream URL.
func (CasterOutput) UrgentMaterialId ¶
func (o CasterOutput) UrgentMaterialId() pulumi.StringPtrOutput
Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
type CasterState ¶
type CasterState struct { // Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds. AutoSwitchUrgentConfig pulumi.StringPtrInput // Turn on the cut-off automatic switch for broadcast preparation. // // true: open. // // false: closed. AutoSwitchUrgentOn pulumi.BoolPtrInput // The callback address of the user. To receive Callback Notifications, enter an available address and accept the HTTP protocol. If this parameter is set to null, the callback notification from the director Station is canceled by default. CallbackUrl pulumi.StringPtrInput // Guide station name. CasterName pulumi.StringPtrInput // Creation time. CreateTime pulumi.StringPtrInput // Delayed playback. Time unit: seconds. Delay pulumi.Float64PtrInput // Master play domain name. DomainName pulumi.StringPtrInput // Guide station specification type. Value: // - 0: Broadcast single type. // - 1: General purpose. NormType pulumi.IntPtrInput // The paymen type of the resource PaymentType pulumi.StringPtrInput // Carousel effective flag. // // 0: Not in effect. // // 1: Entry into force. ProgramEffect pulumi.IntPtrInput // The carousel station name, which can be configured when using the carousel function. ProgramName pulumi.StringPtrInput // Record configuration information. The format is JSON. The configuration element information is as follows: RecordConfig pulumi.StringPtrInput // Resource Group id ResourceGroupId pulumi.StringPtrInput // resource type ResourceType pulumi.StringPtrInput // The user-defined stream ingest address corresponding to the bypass output address of the guide station. If this parameter is left blank, the streaming address corresponding to the output address automatically generated by Alibaba Cloud is used by default. SideOutputUrl pulumi.StringPtrInput // The list of multiple forwarding stream addresses, which can be the CDN forwarding stream addresses of Alibaba Cloud or a third-party vendor. A guide can add up to 20 RTMP forwarding addresses. SideOutputUrlList pulumi.StringPtrInput // Multi-View synchronization configuration to synchronize multiple video sources. Multi-View synchronization is divided into two modes: // - `mode 0`: (In the anchor mode, multiple video sources are synchronized according to the specified mode.) // - `mode 1`: (Conference mode, there is no concept of anchor video, all video sources are synchronized with each other.) // - `Anchor mode`: hostResourceId: the video source of the anchor in Anchor mode. // - `Conference mode`: no hostRsoureId field, only the resource ids in the resourceIds to be provided. SyncGroupsConfig pulumi.StringPtrInput // The tag of the resource Tags pulumi.StringMapInput // Transcoding configuration. // // JSON format string, Please capitalize the first letter of the internal field of the structure, hump format input. If this parameter is set to null, the transcoding configuration is cleared by default. If the transcoding template is null, an error is reported when the director starts. TranscodeConfig pulumi.StringPtrInput // The ID of the picture material of the media library. UrgentImageId pulumi.StringPtrInput // Prepare the URL of the picture material. UrgentImageUrl pulumi.StringPtrInput // The prepared live stream URL. UrgentLiveStreamUrl pulumi.StringPtrInput // Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default. UrgentMaterialId pulumi.StringPtrInput }
func (CasterState) ElementType ¶
func (CasterState) ElementType() reflect.Type