1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. live
  5. Caster
Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi

alicloud.live.Caster

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi

    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.

    NOTE: Available since v1.238.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const _default = new alicloud.live.Caster("default", {
        casterName: name,
        paymentType: "PayAsYouGo",
        normType: 1,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default = alicloud.live.Caster("default",
        caster_name=name,
        payment_type="PayAsYouGo",
        norm_type=1)
    
    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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var @default = new AliCloud.Live.Caster("default", new()
        {
            CasterName = name,
            PaymentType = "PayAsYouGo",
            NormType = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.live.Caster;
    import com.pulumi.alicloud.live.CasterArgs;
    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 config = ctx.config();
            final var name = config.get("name").orElse("terraform-example");
            var default_ = new Caster("default", CasterArgs.builder()
                .casterName(name)
                .paymentType("PayAsYouGo")
                .normType("1")
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: terraform-example
    resources:
      default:
        type: alicloud:live:Caster
        properties:
          casterName: ${name}
          paymentType: PayAsYouGo
          normType: '1'
    

    Create Caster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Caster(name: string, args: CasterArgs, opts?: CustomResourceOptions);
    @overload
    def Caster(resource_name: str,
               args: CasterArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Caster(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               norm_type: Optional[int] = None,
               payment_type: Optional[str] = None,
               record_config: Optional[str] = None,
               resource_group_id: Optional[str] = None,
               delay: Optional[float] = None,
               domain_name: Optional[str] = None,
               callback_url: Optional[str] = None,
               auto_switch_urgent_on: Optional[bool] = None,
               program_effect: Optional[int] = None,
               program_name: Optional[str] = None,
               auto_switch_urgent_config: Optional[str] = None,
               caster_name: Optional[str] = None,
               resource_type: Optional[str] = None,
               side_output_url: Optional[str] = None,
               side_output_url_list: Optional[str] = None,
               sync_groups_config: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               transcode_config: Optional[str] = None,
               urgent_image_id: Optional[str] = None,
               urgent_image_url: Optional[str] = None,
               urgent_live_stream_url: Optional[str] = None,
               urgent_material_id: Optional[str] = None)
    func NewCaster(ctx *Context, name string, args CasterArgs, opts ...ResourceOption) (*Caster, error)
    public Caster(string name, CasterArgs args, CustomResourceOptions? opts = null)
    public Caster(String name, CasterArgs args)
    public Caster(String name, CasterArgs args, CustomResourceOptions options)
    
    type: alicloud:live:Caster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args CasterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CasterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CasterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CasterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CasterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var casterResource = new AliCloud.Live.Caster("casterResource", new()
    {
        NormType = 0,
        PaymentType = "string",
        RecordConfig = "string",
        ResourceGroupId = "string",
        Delay = 0,
        DomainName = "string",
        CallbackUrl = "string",
        AutoSwitchUrgentOn = false,
        ProgramEffect = 0,
        ProgramName = "string",
        AutoSwitchUrgentConfig = "string",
        CasterName = "string",
        ResourceType = "string",
        SideOutputUrl = "string",
        SideOutputUrlList = "string",
        SyncGroupsConfig = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TranscodeConfig = "string",
        UrgentImageId = "string",
        UrgentImageUrl = "string",
        UrgentLiveStreamUrl = "string",
        UrgentMaterialId = "string",
    });
    
    example, err := live.NewCaster(ctx, "casterResource", &live.CasterArgs{
    	NormType:               pulumi.Int(0),
    	PaymentType:            pulumi.String("string"),
    	RecordConfig:           pulumi.String("string"),
    	ResourceGroupId:        pulumi.String("string"),
    	Delay:                  pulumi.Float64(0),
    	DomainName:             pulumi.String("string"),
    	CallbackUrl:            pulumi.String("string"),
    	AutoSwitchUrgentOn:     pulumi.Bool(false),
    	ProgramEffect:          pulumi.Int(0),
    	ProgramName:            pulumi.String("string"),
    	AutoSwitchUrgentConfig: pulumi.String("string"),
    	CasterName:             pulumi.String("string"),
    	ResourceType:           pulumi.String("string"),
    	SideOutputUrl:          pulumi.String("string"),
    	SideOutputUrlList:      pulumi.String("string"),
    	SyncGroupsConfig:       pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TranscodeConfig:     pulumi.String("string"),
    	UrgentImageId:       pulumi.String("string"),
    	UrgentImageUrl:      pulumi.String("string"),
    	UrgentLiveStreamUrl: pulumi.String("string"),
    	UrgentMaterialId:    pulumi.String("string"),
    })
    
    var casterResource = new Caster("casterResource", CasterArgs.builder()
        .normType(0)
        .paymentType("string")
        .recordConfig("string")
        .resourceGroupId("string")
        .delay(0)
        .domainName("string")
        .callbackUrl("string")
        .autoSwitchUrgentOn(false)
        .programEffect(0)
        .programName("string")
        .autoSwitchUrgentConfig("string")
        .casterName("string")
        .resourceType("string")
        .sideOutputUrl("string")
        .sideOutputUrlList("string")
        .syncGroupsConfig("string")
        .tags(Map.of("string", "string"))
        .transcodeConfig("string")
        .urgentImageId("string")
        .urgentImageUrl("string")
        .urgentLiveStreamUrl("string")
        .urgentMaterialId("string")
        .build());
    
    caster_resource = alicloud.live.Caster("casterResource",
        norm_type=0,
        payment_type="string",
        record_config="string",
        resource_group_id="string",
        delay=0,
        domain_name="string",
        callback_url="string",
        auto_switch_urgent_on=False,
        program_effect=0,
        program_name="string",
        auto_switch_urgent_config="string",
        caster_name="string",
        resource_type="string",
        side_output_url="string",
        side_output_url_list="string",
        sync_groups_config="string",
        tags={
            "string": "string",
        },
        transcode_config="string",
        urgent_image_id="string",
        urgent_image_url="string",
        urgent_live_stream_url="string",
        urgent_material_id="string")
    
    const casterResource = new alicloud.live.Caster("casterResource", {
        normType: 0,
        paymentType: "string",
        recordConfig: "string",
        resourceGroupId: "string",
        delay: 0,
        domainName: "string",
        callbackUrl: "string",
        autoSwitchUrgentOn: false,
        programEffect: 0,
        programName: "string",
        autoSwitchUrgentConfig: "string",
        casterName: "string",
        resourceType: "string",
        sideOutputUrl: "string",
        sideOutputUrlList: "string",
        syncGroupsConfig: "string",
        tags: {
            string: "string",
        },
        transcodeConfig: "string",
        urgentImageId: "string",
        urgentImageUrl: "string",
        urgentLiveStreamUrl: "string",
        urgentMaterialId: "string",
    });
    
    type: alicloud:live:Caster
    properties:
        autoSwitchUrgentConfig: string
        autoSwitchUrgentOn: false
        callbackUrl: string
        casterName: string
        delay: 0
        domainName: string
        normType: 0
        paymentType: string
        programEffect: 0
        programName: string
        recordConfig: string
        resourceGroupId: string
        resourceType: string
        sideOutputUrl: string
        sideOutputUrlList: string
        syncGroupsConfig: string
        tags:
            string: string
        transcodeConfig: string
        urgentImageId: string
        urgentImageUrl: string
        urgentLiveStreamUrl: string
        urgentMaterialId: string
    

    Caster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Caster resource accepts the following input properties:

    NormType int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    PaymentType string
    The paymen type of the resource
    AutoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    AutoSwitchUrgentOn bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    CallbackUrl string
    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.
    CasterName string
    Guide station name.
    Delay double
    Delayed playback. Time unit: seconds.
    DomainName string
    Master play domain name.
    ProgramEffect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    ProgramName string
    The carousel station name, which can be configured when using the carousel function.
    RecordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    ResourceGroupId string
    Resource Group id
    ResourceType string
    resource type
    SideOutputUrl string
    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.
    SideOutputUrlList string
    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.
    SyncGroupsConfig string
    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.
    Tags Dictionary<string, string>
    The tag of the resource
    TranscodeConfig string

    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.

    UrgentImageId string
    The ID of the picture material of the media library.
    UrgentImageUrl string
    Prepare the URL of the picture material.
    UrgentLiveStreamUrl string
    The prepared live stream URL.
    UrgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    NormType int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    PaymentType string
    The paymen type of the resource
    AutoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    AutoSwitchUrgentOn bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    CallbackUrl string
    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.
    CasterName string
    Guide station name.
    Delay float64
    Delayed playback. Time unit: seconds.
    DomainName string
    Master play domain name.
    ProgramEffect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    ProgramName string
    The carousel station name, which can be configured when using the carousel function.
    RecordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    ResourceGroupId string
    Resource Group id
    ResourceType string
    resource type
    SideOutputUrl string
    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.
    SideOutputUrlList string
    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.
    SyncGroupsConfig string
    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.
    Tags map[string]string
    The tag of the resource
    TranscodeConfig string

    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.

    UrgentImageId string
    The ID of the picture material of the media library.
    UrgentImageUrl string
    Prepare the URL of the picture material.
    UrgentLiveStreamUrl string
    The prepared live stream URL.
    UrgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    normType Integer
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType String
    The paymen type of the resource
    autoSwitchUrgentConfig String
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn Boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl String
    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.
    casterName String
    Guide station name.
    delay Double
    Delayed playback. Time unit: seconds.
    domainName String
    Master play domain name.
    programEffect Integer

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName String
    The carousel station name, which can be configured when using the carousel function.
    recordConfig String
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId String
    Resource Group id
    resourceType String
    resource type
    sideOutputUrl String
    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.
    sideOutputUrlList String
    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.
    syncGroupsConfig String
    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.
    tags Map<String,String>
    The tag of the resource
    transcodeConfig String

    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.

    urgentImageId String
    The ID of the picture material of the media library.
    urgentImageUrl String
    Prepare the URL of the picture material.
    urgentLiveStreamUrl String
    The prepared live stream URL.
    urgentMaterialId String
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    normType number
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType string
    The paymen type of the resource
    autoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl string
    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.
    casterName string
    Guide station name.
    delay number
    Delayed playback. Time unit: seconds.
    domainName string
    Master play domain name.
    programEffect number

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName string
    The carousel station name, which can be configured when using the carousel function.
    recordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId string
    Resource Group id
    resourceType string
    resource type
    sideOutputUrl string
    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.
    sideOutputUrlList string
    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.
    syncGroupsConfig string
    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.
    tags {[key: string]: string}
    The tag of the resource
    transcodeConfig string

    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.

    urgentImageId string
    The ID of the picture material of the media library.
    urgentImageUrl string
    Prepare the URL of the picture material.
    urgentLiveStreamUrl string
    The prepared live stream URL.
    urgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    norm_type int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    payment_type str
    The paymen type of the resource
    auto_switch_urgent_config str
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    auto_switch_urgent_on bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callback_url str
    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.
    caster_name str
    Guide station name.
    delay float
    Delayed playback. Time unit: seconds.
    domain_name str
    Master play domain name.
    program_effect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    program_name str
    The carousel station name, which can be configured when using the carousel function.
    record_config str
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resource_group_id str
    Resource Group id
    resource_type str
    resource type
    side_output_url str
    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.
    side_output_url_list str
    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.
    sync_groups_config str
    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.
    tags Mapping[str, str]
    The tag of the resource
    transcode_config str

    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.

    urgent_image_id str
    The ID of the picture material of the media library.
    urgent_image_url str
    Prepare the URL of the picture material.
    urgent_live_stream_url str
    The prepared live stream URL.
    urgent_material_id str
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    normType Number
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType String
    The paymen type of the resource
    autoSwitchUrgentConfig String
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn Boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl String
    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.
    casterName String
    Guide station name.
    delay Number
    Delayed playback. Time unit: seconds.
    domainName String
    Master play domain name.
    programEffect Number

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName String
    The carousel station name, which can be configured when using the carousel function.
    recordConfig String
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId String
    Resource Group id
    resourceType String
    resource type
    sideOutputUrl String
    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.
    sideOutputUrlList String
    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.
    syncGroupsConfig String
    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.
    tags Map<String>
    The tag of the resource
    transcodeConfig String

    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.

    urgentImageId String
    The ID of the picture material of the media library.
    urgentImageUrl String
    Prepare the URL of the picture material.
    urgentLiveStreamUrl String
    The prepared live stream URL.
    urgentMaterialId String
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Caster resource produces the following output properties:

    CreateTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Caster Resource

    Get an existing Caster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CasterState, opts?: CustomResourceOptions): Caster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_switch_urgent_config: Optional[str] = None,
            auto_switch_urgent_on: Optional[bool] = None,
            callback_url: Optional[str] = None,
            caster_name: Optional[str] = None,
            create_time: Optional[str] = None,
            delay: Optional[float] = None,
            domain_name: Optional[str] = None,
            norm_type: Optional[int] = None,
            payment_type: Optional[str] = None,
            program_effect: Optional[int] = None,
            program_name: Optional[str] = None,
            record_config: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            resource_type: Optional[str] = None,
            side_output_url: Optional[str] = None,
            side_output_url_list: Optional[str] = None,
            sync_groups_config: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            transcode_config: Optional[str] = None,
            urgent_image_id: Optional[str] = None,
            urgent_image_url: Optional[str] = None,
            urgent_live_stream_url: Optional[str] = None,
            urgent_material_id: Optional[str] = None) -> Caster
    func GetCaster(ctx *Context, name string, id IDInput, state *CasterState, opts ...ResourceOption) (*Caster, error)
    public static Caster Get(string name, Input<string> id, CasterState? state, CustomResourceOptions? opts = null)
    public static Caster get(String name, Output<String> id, CasterState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:live:Caster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    AutoSwitchUrgentOn bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    CallbackUrl string
    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.
    CasterName string
    Guide station name.
    CreateTime string
    Creation time.
    Delay double
    Delayed playback. Time unit: seconds.
    DomainName string
    Master play domain name.
    NormType int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    PaymentType string
    The paymen type of the resource
    ProgramEffect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    ProgramName string
    The carousel station name, which can be configured when using the carousel function.
    RecordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    ResourceGroupId string
    Resource Group id
    ResourceType string
    resource type
    SideOutputUrl string
    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.
    SideOutputUrlList string
    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.
    SyncGroupsConfig string
    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.
    Tags Dictionary<string, string>
    The tag of the resource
    TranscodeConfig string

    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.

    UrgentImageId string
    The ID of the picture material of the media library.
    UrgentImageUrl string
    Prepare the URL of the picture material.
    UrgentLiveStreamUrl string
    The prepared live stream URL.
    UrgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    AutoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    AutoSwitchUrgentOn bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    CallbackUrl string
    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.
    CasterName string
    Guide station name.
    CreateTime string
    Creation time.
    Delay float64
    Delayed playback. Time unit: seconds.
    DomainName string
    Master play domain name.
    NormType int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    PaymentType string
    The paymen type of the resource
    ProgramEffect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    ProgramName string
    The carousel station name, which can be configured when using the carousel function.
    RecordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    ResourceGroupId string
    Resource Group id
    ResourceType string
    resource type
    SideOutputUrl string
    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.
    SideOutputUrlList string
    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.
    SyncGroupsConfig string
    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.
    Tags map[string]string
    The tag of the resource
    TranscodeConfig string

    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.

    UrgentImageId string
    The ID of the picture material of the media library.
    UrgentImageUrl string
    Prepare the URL of the picture material.
    UrgentLiveStreamUrl string
    The prepared live stream URL.
    UrgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    autoSwitchUrgentConfig String
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn Boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl String
    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.
    casterName String
    Guide station name.
    createTime String
    Creation time.
    delay Double
    Delayed playback. Time unit: seconds.
    domainName String
    Master play domain name.
    normType Integer
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType String
    The paymen type of the resource
    programEffect Integer

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName String
    The carousel station name, which can be configured when using the carousel function.
    recordConfig String
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId String
    Resource Group id
    resourceType String
    resource type
    sideOutputUrl String
    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.
    sideOutputUrlList String
    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.
    syncGroupsConfig String
    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.
    tags Map<String,String>
    The tag of the resource
    transcodeConfig String

    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.

    urgentImageId String
    The ID of the picture material of the media library.
    urgentImageUrl String
    Prepare the URL of the picture material.
    urgentLiveStreamUrl String
    The prepared live stream URL.
    urgentMaterialId String
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    autoSwitchUrgentConfig string
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl string
    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.
    casterName string
    Guide station name.
    createTime string
    Creation time.
    delay number
    Delayed playback. Time unit: seconds.
    domainName string
    Master play domain name.
    normType number
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType string
    The paymen type of the resource
    programEffect number

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName string
    The carousel station name, which can be configured when using the carousel function.
    recordConfig string
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId string
    Resource Group id
    resourceType string
    resource type
    sideOutputUrl string
    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.
    sideOutputUrlList string
    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.
    syncGroupsConfig string
    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.
    tags {[key: string]: string}
    The tag of the resource
    transcodeConfig string

    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.

    urgentImageId string
    The ID of the picture material of the media library.
    urgentImageUrl string
    Prepare the URL of the picture material.
    urgentLiveStreamUrl string
    The prepared live stream URL.
    urgentMaterialId string
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    auto_switch_urgent_config str
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    auto_switch_urgent_on bool

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callback_url str
    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.
    caster_name str
    Guide station name.
    create_time str
    Creation time.
    delay float
    Delayed playback. Time unit: seconds.
    domain_name str
    Master play domain name.
    norm_type int
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    payment_type str
    The paymen type of the resource
    program_effect int

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    program_name str
    The carousel station name, which can be configured when using the carousel function.
    record_config str
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resource_group_id str
    Resource Group id
    resource_type str
    resource type
    side_output_url str
    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.
    side_output_url_list str
    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.
    sync_groups_config str
    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.
    tags Mapping[str, str]
    The tag of the resource
    transcode_config str

    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.

    urgent_image_id str
    The ID of the picture material of the media library.
    urgent_image_url str
    Prepare the URL of the picture material.
    urgent_live_stream_url str
    The prepared live stream URL.
    urgent_material_id str
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.
    autoSwitchUrgentConfig String
    Automatic standby broadcast configuration. eofThres: indicates that the broadcast is automatically cut and prepared after the flow interruption time, in seconds.
    autoSwitchUrgentOn Boolean

    Turn on the cut-off automatic switch for broadcast preparation.

    true: open.

    false: closed.

    callbackUrl String
    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.
    casterName String
    Guide station name.
    createTime String
    Creation time.
    delay Number
    Delayed playback. Time unit: seconds.
    domainName String
    Master play domain name.
    normType Number
    Guide station specification type. Value:

    • 0: Broadcast single type.
    • 1: General purpose.
    paymentType String
    The paymen type of the resource
    programEffect Number

    Carousel effective flag.

    0: Not in effect.

    1: Entry into force.

    programName String
    The carousel station name, which can be configured when using the carousel function.
    recordConfig String
    Record configuration information. The format is JSON. The configuration element information is as follows:
    resourceGroupId String
    Resource Group id
    resourceType String
    resource type
    sideOutputUrl String
    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.
    sideOutputUrlList String
    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.
    syncGroupsConfig String
    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.
    tags Map<String>
    The tag of the resource
    transcodeConfig String

    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.

    urgentImageId String
    The ID of the picture material of the media library.
    urgentImageUrl String
    Prepare the URL of the picture material.
    urgentLiveStreamUrl String
    The prepared live stream URL.
    urgentMaterialId String
    Prepared video, media library material ID. If this parameter is set to null, the standby configuration is cleared by default.

    Import

    Live Caster can be imported using the id, e.g.

    $ pulumi import alicloud:live/caster:Caster example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.73.0 published on Wednesday, Jan 15, 2025 by Pulumi