tencent cloud

Feedback

Data Types

Last updated: 2023-11-22 16:11:52

    CacheInfo

    Cache configuration

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannel.

    Name Type Required Description
    Info Array of CacheInfoInfo No List of timeout parameter configuration
    Note: this field may return null, indicating that no valid value was found.

    CacheInfoInfo

    Timeout information for cache configuration

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannel.

    Name Type Required Description
    Timeout Integer Yes Timeout period (ms), which must be an integer multiple of 1000
    .m3u8/.mpd: [1000, 60000]
    .ts/.m4s/.mp4: [10000, 1800000]
    Ext String No File extension. Valid values: .m3u8, .ts, .mpd, .m4s, .mp4
    Note: this field may return null, indicating that no valid value was found.

    ChannelInfo

    Channel information.

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.

    Name Type Description
    Id String Channel ID.
    Name String Channel name.
    Protocol String Channel protocol.
    Points PointInfo Channel input and output.
    CacheInfo CacheInfo Cache configuration
    Note: this field may return null, indicating that no valid value was found.

    EndpointAuthInfo

    The authentication information of channel endpoints.

    Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.

    Name Type Required Description
    WhiteIpList Array of String No The security group allowlist in CIDR format.
    Note: this field may return null, indicating that no valid values can be obtained.
    BlackIpList Array of String No The security group blocklist in CIDR format.
    Note: this field may return null, indicating that no valid values can be obtained.
    AuthKey String No The authentication key. Its value is same as X-TENCENT-PACKAGE set in the HTTP request header.
    Note: this field may return null, indicating that no valid values can be obtained.

    EndpointInfo

    Channel endpoint information.

    Used by actions: CreateStreamPackageChannel, CreateStreamPackageChannelEndpoint, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.

    Name Type Description
    Name String Endpoint name.
    Url String Endpoint URL.
    AuthInfo EndpointAuthInfo Endpoint authentication information.

    HarvestJobResp

    HarvestJob response info.

    Used by actions: CreateStreamPackageHarvestJob, DescribeStreamPackageHarvestJob, DescribeStreamPackageHarvestJobs.

    Name Type Description
    ID String HarvestJob ID, a globally unique identifier.
    ChannelName String The associated channel name.
    EndpointName String The associated endpoint name.
    TimeFormat String Time format, supports the following types: 1. Epoch seconds 2. ISO-8601
    StartTime String HarvestJob start time.
    EndTime String HarvestJob end time.
    Destination String The path where the recording file is stored in COS.
    Manifest String The file name of the recording file stored in COS.
    Status String The task status is divided into running: Running, execution completed: Completed, and execution failure: Failed.
    ErrMessage String HarvestJob error message.
    CreateTime Integer HarvestJob creation time, timestamp in seconds.
    ChannelId String The associated ChannelID.
    Region String The region corresponding to the harvest job.

    InputAuthInfo

    Channel input authentication information.

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannelInputAuthInfo.

    Name Type Description
    Username String Username.
    Note: this field may return null, indicating that no valid values can be obtained.
    Password String Password.
    Note: this field may return null, indicating that no valid values can be obtained.

    InputInfo

    Channel input.

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.

    Name Type Description
    Url String Channel input URL.
    Note: this field may return null, indicating that no valid values can be obtained.
    AuthInfo InputAuthInfo Channel input authentication information.

    PointInfo

    Channel input and output.

    Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.

    Name Type Description
    Inputs Array of InputInfo Channel input list.
    Endpoints Array of EndpointInfo Channel output list.
    Note: this field may return null, indicating that no valid values can be obtained.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support