Todos os produtos
Search

Este produto

    ApsaraVideo Live:StartRtcCloudRecording

    Central de documentação

    ApsaraVideo Live:StartRtcCloudRecording

    Última atualização: Jul 17, 2026

    Inicia uma tarefa de gravação em nuvem RTC.

    Descrição da operação

    A gravação em nuvem é um recurso pago. Para detalhes sobre cobrança, consulte Taxas de gravação em nuvem.

    Endpoints

    Os seguintes endpoints estão ativos para esta operação:

    RegiãoID da regiãoEndpoint público
    Xangaicn-shanghailive.aliyuncs.com
    Singapuraap-southeast-1live.ap-southeast-1.aliyuncs.com
    EUA (Virgínia)us-east-1live.us-east-1.aliyuncs.com

    Limite de taxa

    O limite de QPS por usuário individual para esta operação é de 50 chamadas por segundo. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Invoque esta operação conforme necessário.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    live:StartRtcCloudRecording

    create

    *Todos os recursos.

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    AppId

    string

    Sim

    O ID do aplicativo ao qual o canal a ser gravado pertence. O aplicativo deve pertencer à conta primária da conta que chama esta operação.

    ********-7074-****-9ef5-85c19a4*****
    ChannelId

    string

    Sim

    O ID do canal a ser gravado. Certifique-se de que o canal tenha usuários ativos quando você chamar esta operação. Caso contrário, a tarefa de gravação não será criada.

    room1024
    SubscribeParams

    object

    Sim

    Os parâmetros de assinatura.

    SubscribeUserIdList

    array<object>

    Sim

    A lista de entradas UserId assinadas. No modo de gravação de fluxo único, cada UserId é gravado separadamente. No modo de gravação com mixagem de fluxos, o áudio e o vídeo de todos os UserIds são misturados em um único conjunto de áudio e vídeo.

    Nota

    • O array não pode estar vazio e suporta no máximo 17 elementos.

    object

    Não

    As informações sobre um UserId assinado.

    UserId

    string

    Sim

    O UserId assinado.

    userA
    StreamType

    integer

    Não

    O tipo de mídia do UserId assinado. Valores válidos:

    • 0: fluxo original, que inclui áudio e vídeo. (Padrão)

    • 1: fluxo apenas de áudio.

    • 2: fluxo apenas de vídeo (válido apenas no modo de gravação com mixagem de fluxos).

    Valores válidos:

    • 0 :

      fluxo original, que inclui áudio e vídeo.

    • 1 :

      fluxo apenas de áudio.

    • 2 :

      fluxo apenas de vídeo.

    0
    SourceType

    integer

    Não

    O tipo de fluxo de entrada de vídeo do UserId. Este parâmetro é válido apenas quando a assinatura não é apenas de áudio (StreamType != 1). Valores válidos:

    • 0: câmera. (Padrão)

    • 1: compartilhamento de tela.

    Valores válidos:

    • 0 :

      câmera.

    • 1 :

      compartilhamento de tela.

    0
    RecordParams

    object

    Sim

    Os parâmetros de gravação.

    RecordMode

    integer

    Sim

    O modo de gravação. Valores válidos:

    • 0: modo de gravação de fluxo único. Um arquivo de gravação separado é gerado para cada UserId assinado.

    • 1: modo de gravação com mixagem de fluxos. Os fluxos de todos os UserIds assinados são misturados e transcodificados, e apenas um conjunto de arquivos de gravação é gerado.

    Valores válidos:

    • 0 :

      Modo de gravação de fluxo único. Um arquivo de gravação separado é gerado para cada UserId assinado.

    • 1 :

      Modo de gravação com mixagem de fluxos. Os fluxos de todos os UserIds assinados são misturados e transcodificados, e apenas um conjunto de arquivos de gravação é gerado.

    0
    StreamType

    integer

    Não

    O tipo de mídia do fluxo de saída da gravação. Valores válidos:

    • 0: fluxo original, que inclui áudio e vídeo. (Padrão)

    • 1: fluxo apenas de áudio.

    • 2: fluxo apenas de vídeo.

    Valores válidos:

    • 0 :

      fluxo original, que inclui áudio e vídeo.

    • 1 :

      fluxo apenas de áudio.

    • 2 :

      fluxo apenas de vídeo.

    0
    MaxFileDuration

    integer

    Não

    A duração máxima de um arquivo de gravação, em segundos. Arquivos de gravação que excedem essa duração são divididos. O valor deve estar no intervalo de [180, 7200], que corresponde a no máximo 2 horas. Se não especificado, o valor padrão é 2 horas.

    7200
    StorageParams

    object

    Sim

    Os parâmetros de armazenamento.

    StorageType

    integer

    Sim

    O método de armazenamento. Valores válidos:

    • 0: VOD

    • 1: OSS

    Valores válidos:

    • 0 :

      VOD.

    • 1 :

      OSS.

    1
    FileInfo

    array<object>

    Não

    As informações de armazenamento de arquivos, que especificam o formato, o local de armazenamento e a nomenclatura dos arquivos de gravação. Este parâmetro é válido apenas quando StorageType está definido como OSS.

    Nota

    Um arquivo de gravação é gerado para cada elemento no array com base na configuração correspondente. Se nenhum formato for especificado, o formato HLS será usado por padrão.

    object

    Não

    A configuração de armazenamento para cada formato de arquivo.

    Format

    string

    Sim

    O formato de armazenamento do arquivo. Valores válidos:

    • HLS

    • MP4

    • MP3

    Valores válidos:

    • MP4 :

      Formato MP4.

    • MP3 :

      Formato MP3.

    • HLS :

      Formato HLS.

    HLS
    FileNamePattern

    string

    Não

    O formato de nomenclatura do arquivo. Você pode selecionar e combinar as seguintes variáveis em qualquer ordem:

    • AppId

    • ChannelId

    • UserId (obrigatório no modo de fluxo único; inválido no modo de mixagem de fluxos, onde é mantido como a string {UserId} se selecionado)

    • RecordMode

      • Quando o valor é 0, corresponde a Single.

      • Quando o valor é 1, corresponde a Mix.

    • SourceType

      • No modo de fluxo único, quando o tipo de fluxo é apenas vídeo, este parâmetro entra em vigor. SourceType pode ser definido como:

        • 0: corresponde a C (Camera) para fluxo de vídeo da câmera.

        • 1: corresponde a S (Screen) para fluxo de vídeo de compartilhamento de tela.

      • No modo de fluxo único, quando o tipo de fluxo é apenas áudio, SourceType é automaticamente definido como A (Audio) para indicar que o conteúdo da gravação é um fluxo apenas de áudio.

      • No modo de fluxo único, quando o tipo de fluxo é fluxo original, este parâmetro entra em vigor. SourceType pode ser definido como:

        • 0: corresponde a OC (Original Camera) para fluxo original da câmera.

        • 1: corresponde a OS (Original Screen) para fluxo original de compartilhamento de tela.

      • Em outros cenários, a configuração de SourceType é inválida. Se você configurar manualmente o SourceType, o sistema manterá a string de espaço reservado {SourceType}.

    • StreamType (usa o parâmetro StreamType em RecordParams)

      • Quando o valor é 0, corresponde a AV (Audio Video) para fluxos de áudio e vídeo.

      • Quando o valor é 1, corresponde a A (Audio) para fluxo de áudio.

      • Quando o valor é 2, corresponde a V (Video) para fluxo de vídeo.

    • StartTime: a hora em que a gravação começa, no fuso horário UTC+8, em um formato semelhante a 2025-03-25-11:27:28. (Obrigatório quando o valor padrão não é usado.)

    Valores padrão:

    • Modo de gravação de fluxo único

      • {AppId}_{ChannelId}_{UserId}_{StartTime}

      • Se diferentes valores de StreamType ou SourceType forem assinados para o mesmo UserId, o valor padrão é {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}.

    • Modo de gravação com mixagem de fluxos

      • {AppId}_{ChannelId}_{StartTime}

    Nota

    • A string pode conter apenas as variáveis listadas acima. Os nomes das variáveis devem ser colocados entre {}. As variáveis são separadas por um único sublinhado (_). Cada variável pode aparecer no máximo uma vez na string.

    • Depois que o arquivo é nomeado como xxx, ele é salvo em um formato semelhante a TaskId/xxx.m3u8, onde TaskId é o ID da tarefa gerado quando a tarefa de gravação em nuvem é iniciada e é adicionado automaticamente ao caminho de armazenamento.

    {AppId}_{ChannelId}_{StartTime}_{UserId}
    SliceNamePattern

    string

    Não

    O formato de nomenclatura do segmento. Este parâmetro é válido apenas no formato HLS. É semelhante ao FileNamePattern, exceto que uma variável adicional Sequence está disponível:

    • AppId

    • ChannelId

    • UserId (obrigatório no modo de fluxo único; inválido no modo de mixagem de fluxos, onde é mantido como a string {UserId} se selecionado)

    • RecordMode

      • Quando o valor é 0, corresponde a Single.

      • Quando o valor é 1, corresponde a Mix.

    • SourceType

      • No modo de fluxo único, quando o tipo de fluxo é apenas vídeo, este parâmetro entra em vigor. SourceType pode ser definido como:

        • 0: corresponde a C (Camera) para fluxo de vídeo da câmera.

        • 1: corresponde a S (Screen) para fluxo de compartilhamento de tela.

      • No modo de fluxo único, quando o tipo de fluxo é apenas áudio, SourceType é automaticamente definido como A (Audio) para indicar que o conteúdo da gravação é um fluxo apenas de áudio.

      • No modo de fluxo único, quando o tipo de fluxo é fluxo original, este parâmetro entra em vigor. SourceType pode ser definido como:

        • 0: corresponde a OC (Original Camera) para fluxo original da câmera.

        • 1: corresponde a OS (Original Screen) para fluxo original de compartilhamento de tela.

      • Em outros cenários, a configuração de SourceType é inválida. Se você configurar manualmente este parâmetro, o sistema manterá a string de espaço reservado {SourceType}.

    • StreamType (usa o parâmetro StreamType em RecordParams)

      • Quando o valor é 0, corresponde a AV (Audio Video) para fluxos de áudio e vídeo.

      • Quando o valor é 1, corresponde a A (Audio) para fluxo de áudio.

      • Quando o valor é 2, corresponde a V (Video) para fluxo de vídeo.

    • StartTime: a hora em que a gravação começa, no fuso horário UTC+8, em um formato semelhante a 2025-03-25-11:27:28. (Obrigatório quando o valor padrão não é usado.)

    • Sequence: no formato HLS, o nome do arquivo ts contém Sequence. Esta variável é inválida em outros formatos. (Obrigatório quando o valor padrão não é usado.)

    Valores padrão:

    • Modo de gravação de fluxo único

      • {AppId}_{ChannelId}_{UserId}_{StartTime}_{Sequence}

      • Se diferentes valores de StreamType ou SourceType forem assinados para o mesmo UserId, o valor padrão é {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}_{Sequence}.

    • Modo de gravação com mixagem de fluxos

      • {AppId}_{ChannelId}_{StartTime}_{Sequence}

    Nota

    • A string pode conter apenas as variáveis listadas acima. Os nomes das variáveis devem ser colocados entre {}. As variáveis são separadas por um único sublinhado (_). Cada variável pode aparecer no máximo uma vez na string.

    • Depois que o segmento é nomeado como xxx, ele é salvo em um formato semelhante a TaskId/xxx.ts, onde TaskId é o ID da tarefa gerado quando a tarefa de gravação em nuvem é iniciada e é adicionado automaticamente ao caminho de armazenamento.

    {AppId}_{ChannelId}_{StartTime}_{Sequence}
    FilePathPrefix

    array

    Não

    O caminho de armazenamento do arquivo. Cada elemento no array corresponde a um nível de diretório. Por exemplo, se o valor do parâmetro for ["dir1","dir2"], o arquivo xxx.m3u8 será salvo como dir1/dir2/TaskId/xxx.m3u8. Se este parâmetro estiver vazio, o arquivo será salvo diretamente como TaskId/xxx.m3u8.

    • O TaskId da tarefa é anexado automaticamente ao final do caminho para evitar que arquivos de gravação de diferentes tarefas sejam misturados.

    • Se FilePathPrefix for especificado, cada elemento no array pode conter apenas letras (a-zA-Z), dígitos (0-9), hifens (-) e sublinhados (_), e não pode ser uma string vazia.

    • O comprimento total de todos os níveis de diretório concatenados não pode exceder 128 caracteres (incluindo os caracteres "/" de conexão, mas excluindo o TaskId anexado automaticamente). Por exemplo, se o valor do parâmetro for ["dir1","dir2"], o caminho concatenado é "dir1/dir2/", o que significa que o número total de caracteres em todos os elementos mais o comprimento do array (correspondente ao "/" após cada nível de diretório) não pode exceder 128.

    • O array pode conter no máximo 5 elementos, o que significa que você pode personalizar até 5 níveis de diretório.

    string

    Não

    O nome de cada nível de diretório.

    dir1
    SliceDuration

    integer

    Não

    O comprimento do segmento, em segundos. Este parâmetro é válido apenas no formato HLS. O valor deve estar no intervalo de [10, 30]. (Valor padrão: 30)

    Se você não tiver requisitos especiais, use o valor padrão.

    30
    OSSParams

    object

    Não

    A configuração de armazenamento OSS. Este parâmetro é obrigatório quando o método de armazenamento é OSS e é inválido quando o método de armazenamento é VOD.

    OSSEndpoint

    string

    Sim

    O endpoint do armazenamento OSS. O ID da região correspondente deve corresponder ao endpoint selecionado.

    oss-cn-shanghai.aliyuncs.com
    OSSBucket

    string

    Sim

    O nome do bucket OSS. O bucket deve pertencer à conta primária da conta que chama esta operação.

    mytest-bucket
    VodParams

    object

    Não

    A configuração de armazenamento VOD. Este parâmetro é obrigatório quando o método de armazenamento é VOD e é inválido quando o método de armazenamento é OSS.

    Nota

    • A região EUA (Virgínia) não suporta gravação para VOD.

    StorageLocation

    string

    Não

    O endereço de armazenamento configurado no console de vídeo sob demanda em Gerenciamento de Ativos de Mídia > Gerenciamento de Armazenamento. Os arquivos de gravação são salvos primeiro neste local e depois carregados no VOD.

    Nota

    • Este parâmetro é obrigatório quando StorageType está definido como 0 (modo VOD).

    • Certifique-se de que a região deste endereço de armazenamento corresponda ao endpoint selecionado.

    mytest.oss-cn-shenzhen.aliyuncs.com
    VodTranscodeGroupId

    string

    Não

    O ID do grupo de modelos de transcodificação de vídeo sob demanda.

    Nota

    • Este parâmetro é obrigatório quando StorageType está definido como 0 (modo VOD).

    • Certifique-se de que a região deste ID de grupo de modelos de transcodificação corresponda ao endpoint selecionado.

    ****8a914d3989e9825eb90530b2****
    AutoCompose

    integer

    Não

    Especifica se a mesclagem automática deve ser ativada. Valores válidos:

    • 0: Desativado. (Padrão)

    • 1: Ativado. Quando ativado, o parâmetro ComposeVodTranscodeGroupId deve ser especificado.

    Valores válidos:

    • 0 :

      Desativado.

    • 1 :

      Ativado. Quando ativado, o parâmetro ComposeVodTranscodeGroupId deve ser especificado.

    0
    ComposeVodTranscodeGroupId

    string

    Não

    O ID do grupo de modelos de transcodificação VOD usado para transcodificar o novo vídeo composto automaticamente no ApsaraVideo VOD.

    Nota

    • Este parâmetro é obrigatório apenas quando AutoCompose está definido como 1.

    • Se existir apenas um arquivo de recurso de mídia quando a gravação terminar, a mesclagem automática não será acionada, mesmo que esteja ativada.

    • Para problemas comuns sobre composição automática e transcodificação, consulte FAQ de Live-to-VOD.

    • Para detalhes sobre a cobrança de transcodificação VOD, consulte Cobrança de transcodificação de mídia.

    ****4c34112cfe68248f2f77759c****
    MixTranscodeParams

    object

    Não

    Os parâmetros de transcodificação. Deixe este parâmetro vazio no modo de gravação de fluxo único. Este parâmetro é obrigatório no modo de gravação com mixagem de fluxos.

    FrameFillType

    integer

    Não

    O tipo de preenchimento de quadro quando um fluxo é interrompido. Valores válidos:

    • 0: Preencher com o último quadro. (Padrão)

    Valores válidos:

    • 0 :

      preencher com o último quadro.

    0
    AudioBitrate

    integer

    Sim

    A taxa de bits de áudio em kbps. O valor deve estar no intervalo de [8, 500]. Este parâmetro é obrigatório no modo de mixagem de fluxos.

    300
    AudioChannels

    integer

    Sim

    O número de canais de áudio. Valores válidos:

    • 1: mono.

    • 2: estéreo.

    Este parâmetro é obrigatório no modo de mixagem de fluxos.

    Valores válidos:

    • 1 :

      mono.

    • 2 :

      estéreo.

    2
    AudioSampleRate

    integer

    Sim

    A taxa de amostragem de áudio em Hz. Valores válidos:

    • 8000

    • 16000

    • 32000

    • 44100

    • 48000

    Este parâmetro é obrigatório no modo de mixagem de fluxos.

    Valores válidos:

    • 8000 :

      8000HZ

    • 16000 :

      16000HZ

    • 32000 :

      32000HZ

    • 44100 :

      44100HZ

    • 48000 :

      48000HZ

    32000
    VideoCodec

    string

    Não

    O formato de codificação de vídeo. Valores válidos:

    • H.264 (Padrão)

    • H.265

    Valores válidos:

    • H.264 :

      Codificação H.264.

    • H.265 :

      Codificação H.265.

    H.264
    VideoBitrate

    integer

    Não

    A taxa de bits de vídeo em kbps. O valor deve estar no intervalo de [1, 10000]. Este parâmetro é obrigatório no modo de mixagem de fluxos quando se espera que a saída da gravação contenha vídeo. É inválido em outros casos.

    5000
    VideoFramerate

    integer

    Não

    A taxa de quadros de vídeo em fps. O valor deve estar no intervalo de [1, 60]. Este parâmetro é obrigatório no modo de mixagem de fluxos quando se espera que a saída da gravação contenha vídeo. É inválido em outros casos.

    30
    VideoGop

    integer

    Não

    O GOP de vídeo. Existe um I-frame a cada VideoGop quadros. O valor deve estar no intervalo de [1, 60]. Este parâmetro é obrigatório no modo de mixagem de fluxos quando se espera que a saída da gravação contenha vídeo. É inválido em outros casos.

    30
    VideoHeight

    integer

    Não

    A altura do vídeo em pixels. O valor deve estar no intervalo de [0, 1920]. (Valor padrão: 0)

    480
    VideoWidth

    integer

    Não

    A largura do vídeo em pixels. O valor deve estar no intervalo de [0, 1920]. (Valor padrão: 0)

    640
    MixLayoutParams

    object

    Não

    Os parâmetros de layout. Deixe este parâmetro vazio no modo de gravação de fluxo único. Este parâmetro é obrigatório no modo de gravação com mixagem de fluxos quando se espera que a saída da gravação contenha arquivos que não sejam apenas de áudio.

    MixBackground

    object

    Não

    A imagem de fundo global para mixagem de fluxos.

    RenderMode

    integer

    Não

    O modo de exibição para a saída. Valores válidos:

    • 0: Cortar. (Padrão)

    • 1: Escalar e exibir com bordas pretas.

    Valores válidos:

    • 0 :

      cortar.

    • 1 :

      escalar e exibir com bordas pretas.

    0
    Url

    string

    Não

    A URL da imagem de fundo. O comprimento máximo é de 2048 caracteres.

    https://xxxx.com/photos/my-test-picture.png
    UserPanes

    array<object>

    Não

    As informações de layout de janela para usuários assinados. Apenas UserIds com informações de layout configuradas são colocados no vídeo. Este parâmetro é obrigatório no modo de mixagem de fluxos ao gravar arquivos que não sejam apenas de áudio.

    array<object>

    Não

    A configuração da janela no vídeo.

    UserId

    string

    Não

    O UserId correspondente a esta janela.

    • Se UserId não for especificado, os usuários assinados serão preenchidos nas janelas na ordem em que entrarem no canal.

    • A combinação de UserId e SourceType especificada aqui deve estar incluída em SubscribeUserIdList.

    • Assinaturas apenas de áudio não podem ser adicionadas ao layout.

    userA
    SourceType

    integer

    Não

    O tipo de fluxo de entrada de vídeo do UserId. Definir SourceType é inválido quando UserId não é especificado. Valores válidos:

    • 0: câmera. (Padrão)

    • 1: compartilhamento de tela.

    A combinação de UserId e SourceType especificada aqui deve estar incluída em SubscribeUserIdList.

    Valores válidos:

    • 0 :

      câmera.

    • 1 :

      compartilhamento de tela.

    0
    Height

    string

    Não

    A altura do painel como uma porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Valor padrão: 0)

    0.5
    Width

    string

    Não

    A largura do painel como uma porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Valor padrão: 0)

    0.5
    X

    string

    Não

    A coordenada X como uma porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Valor padrão: 0)

    0
    Y

    string

    Não

    A coordenada Y como uma porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Valor padrão: 0)

    0
    ZOrder

    integer

    Não

    A ordem de empilhamento. 0 é a camada inferior, a camada 1 está acima da camada 0, e assim por diante. (Valor padrão: 0)

    0
    SubBackground

    object

    Não

    A imagem de fundo do subpainel. Quando um usuário desliga a câmera, não iniciou a ingestão de fluxo após entrar ou sai do canal no meio do caminho, a imagem correspondente é exibida na posição do layout.

    RenderMode

    integer

    Não

    O modo de exibição para a saída do subpainel. Valores válidos:

    • 0: Cortar. (Padrão)

    • 1: Escalar e exibir com bordas pretas.

    Valores válidos:

    • 0 :

      cortar.

    • 1 :

      escalar e exibir com bordas pretas.

    0
    Url

    string

    Não

    A URL da imagem de fundo. O comprimento máximo é de 2048 caracteres.

    https://xxxx.com/photos/my-test-pane-picture.png
    NotifyUrl

    string

    Não

    A URL para receber mensagens de callback. Mensagens de status da tarefa são enviadas para esta URL via POST no formato JSON. O comprimento máximo é de 2048 caracteres.

    Para detalhes sobre mensagens de callback, consulte Documentação.

    http://xxxx/test/mycallback
    NotifyAuthKey

    string

    Não

    A chave de autenticação para mensagens de callback. Se não especificada, nenhuma autenticação é realizada. Se especificada, o comprimento deve estar no intervalo de [16, 64] caracteres e conter apenas letras maiúsculas, minúsculas e dígitos.

    • Se NotifyUrl não for especificado, NotifyAuthKey também será inválido.

    • Quando um NotifyAuthKey válido é definido, o conteúdo de autenticação é incluído na mensagem de callback.

    mytestkeymytestkey
    NotifyFileUploadedFormat

    array

    Não

    Os formatos especificados para os quais uma mensagem de callback é enviada quando um evento de geração de arquivo de gravação (RecordFileUploaded) é acionado.

    string

    Não

    O formato de arquivo específico para o qual um callback é recebido. Valores válidos (não diferencia maiúsculas de minúsculas):

    • SLICE

    • HLS

    • MP4

    • MP3

    O modo de armazenamento VOD não é suportado. Para o modo de armazenamento OSS, o formato selecionado deve estar incluído nos formatos de arquivo especificados em StorageParams.FileInfo.

    MP4
    MaxIdleTime

    integer

    Não

    O período de tempo limite de ociosidade. Quando a tarefa permanece ociosa por mais tempo do que MaxIdleTime, a tarefa é parada automaticamente. Unidade: segundos. O valor deve estar no intervalo de [10, 14400], que corresponde a no máximo 4 horas. (Valor padrão: 300 segundos)

    • No modo de gravação com mixagem de fluxos, a tarefa é considerada ociosa quando todos os fluxos de usuários assinados param a ingestão de fluxo.

    • No modo de gravação de fluxo único, os fluxos assinados são independentes uns dos outros. Quando qualquer fluxo para a ingestão de fluxo, ele é considerado ocioso. Após MaxIdleTime ser atingido, a gravação desse fluxo é parada. Quando todos os fluxos assinados tiverem expirado devido à ociosidade, toda a tarefa de gravação em nuvem será parada.

    600

    • No modo de gravação de fluxo único:

      • Você pode assinar simultaneamente os fluxos de câmera e de compartilhamento de tela do mesmo UserId, mas os parâmetros FileNamePattern e SliceNamePattern devem incluir a variável SourceType para evitar que os arquivos de gravação se sobrescrevam.

      • Assinar apenas o fluxo de vídeo de um UserId não é suportado. No modo de fluxo único, UserInfo.StreamType não pode ser definido como 2.

    • No modo de gravação de fluxo único:

      • Se RecordParams.StreamType estiver definido como apenas áudio (valor 1), SubscribeParams não poderá conter nenhuma assinatura apenas de vídeo (valor 2 em SubscribeParams).

      • Se RecordParams.StreamType estiver definido como apenas vídeo (valor 2), SubscribeParams não poderá conter nenhuma assinatura apenas de áudio (valor 1 em SubscribeParams).

    • No modo de gravação com mixagem de fluxos:

      • Se RecordParams.StreamType estiver definido como apenas áudio (valor 1), nem todos os UserIds em SubscribeParams podem estar assinados como apenas vídeo (todos os valores de SubscribeParams definidos como 2).

      • Se RecordParams.StreamType estiver definido como apenas vídeo (valor 2), nem todos os UserIds em SubscribeParams podem estar assinados como apenas áudio (todos os valores de SubscribeParams definidos como 1).

    • Durante a gravação, se o canal for fechado no meio do caminho, os usuários devem entrar novamente e retomar a ingestão de fluxo dentro do período de tempo limite de ociosidade. Caso contrário, a tarefa será parada automaticamente.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    RequestId

    string

    O ID da solicitação.

    ******58-5876-****-83CA-B56278******
    TaskId

    string

    O ID da tarefa.

    ******73-8501-****-8ac1-72295a******

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "******58-5876-****-83CA-B56278******",
  "TaskId": "******73-8501-****-8ac1-72295a******"
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvalidParameter.NotifyUrl %s, please check the notifyUrl. O formato do parâmetro NotifyUrl é inválido. Verifique o parâmetro.
    400 InvalidParameter.StorageParams.FileInfo %s, please check the fileInfo of storageParams. O parâmetro FileInfo contém campos inválidos. Verifique o parâmetro.
    400 InvalidParameter.StorageParams.OSSParams %s, please check the ossParams of storageParams. O parâmetro OSSParams contém campos inválidos. Verifique o parâmetro.
    400 NotFound.OSSBucket %s, please check the ossBucket of storageParams. O OSSBucket especificado não existe.
    400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams. O parâmetro SubscribeUserIdList é inválido. Verifique o parâmetro.
    400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams. O parâmetro UserPanes contém campos inválidos. Verifique o parâmetro.
    400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams. O parâmetro MixTranscodeParams contém campos inválidos. Verifique o parâmetro.
    400 MissingParameter %s. Um parâmetro obrigatório está ausente.
    403 InvalidParameter.UserId %s, please check the UserId. O parâmetro UserId é inválido. Verifique o parâmetro.
    403 QuotaExceed.RunningTask The number of active cloud recording tasks has reached the limit. O número de tarefas ativas de gravação em nuvem atingiu o limite superior.
    404 InvalidParameter.ChannelId %s, please check the channelId.
    404 InvalidParameter.AppId %s, please check the appId. O parâmetro AppId é inválido. Verifique o valor do parâmetro.
    405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams.
    405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey.
    405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime.
    405 InvalidParameter.RecordParams %s, please check the recordParams.
    405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. O parâmetro StorageType é inválido. Verifique o valor do parâmetro.
    405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. O parâmetro NotifyFileUploadedFormat é inválido. Verifique o valor do parâmetro.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.