Todos os produtos
Search

Este produto

    ApsaraVideo Live:StartRtcCloudRecording

    Central de documentação

    ApsaraVideo Live:StartRtcCloudRecording

    Última atualização: Oct 12, 2026

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

    Descrição da operação

    A gravação em nuvem é um recurso cobrável. Para detalhes de cobrança, consulte Cobrança de gravação em nuvem.

    Nota

    • Após o início de uma tarefa de gravação, as taxas ainda são incorridas no estado ocioso (quando nenhum fluxo é ingerido). Portanto, chame StopRtcCloudRecording prontamente quando a gravação terminar ou reduza o valor de MaxIdleTime conforme necessário.

    • O número padrão de tarefas simultâneas suportadas por conta varia de acordo com a região:

      • China (Shanghai): 500 tarefas simultâneas

      • Singapura: 200 tarefas simultâneas

      • EUA (Virgínia): 500 tarefas simultâneas

    • Para aumentar a cota, entre em contato com o gerente de conta da Alibaba Cloud ou envie um ticket. Para mais informações sobre como enviar um ticket, consulte Fale conosco.

    Importante Esta operação é assíncrona. Uma chamada bem-sucedida não significa que a tarefa começou a gravar. Recomendamos fortemente que você defina o parâmetro NotifyUrl para receber mensagens sobre o status atual da tarefa.

    Endpoints de registro de serviço

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

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

    Limites de QPS

    O limite de consultas por segundo (QPS) para esta operação é de 50 por usuário. Se o número de chamadas exceder o limite, o limitador será acionado, o que pode afetar seus negócios. Tenha cuidado ao chamar esta operação.

    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 da Alibaba Cloud do chamador atual.

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

    string

    Sim

    O ID do canal a ser gravado. Certifique-se de que haja usuários presentes no canal ao 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 IDs de usuário para assinar. No modo de gravação de fluxo único, cada ID de usuário é gravado separadamente. No modo de gravação de fluxo misto, os fluxos de áudio e vídeo de todos os IDs de usuário são misturados em um único fluxo de áudio e vídeo.

    Nota

    • A matriz não pode estar vazia e pode conter até 17 elementos.

    object

    Não

    As informações sobre o ID de usuário a ser assinado.

    UserId

    string

    Sim

    O ID de usuário a ser assinado.

    userA
    StreamType

    integer

    Não

    O tipo de mídia do ID de usuário a ser 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. Este valor é válido apenas no modo de gravação de fluxo misto.

    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 ID de usuário. Este parâmetro é válido apenas quando um fluxo não exclusivo de áudio é assinado (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 ID de usuário assinado.

    • 1: modo de gravação de fluxo misto. Os fluxos dos IDs de usuário assinados são misturados e transcodificados para gerar um único conjunto de arquivos de gravação.

    Valores válidos:

    • 0 :

      Modo de gravação de fluxo único. Um arquivo de gravação separado é gerado para cada ID de usuário assinado.

    • 1 :

      Modo de gravação de fluxo misto. Os fluxos dos IDs de usuário assinados são misturados e transcodificados para gerar um único conjunto de arquivos de gravação.

    0
    StreamType

    integer

    Não

    O tipo de mídia do fluxo de saída a ser gravado. 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. Os arquivos de gravação que excederem essa duração serão divididos. Valores válidos: 180 a 7200, o que significa um máximo de 2 horas. Se você não especificar este parâmetro, o valor padrão é 7200 (2 horas).

    7200
    StorageParams

    object

    Sim

    Os parâmetros de armazenamento.

    StorageType

    integer

    Sim

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

    • 0: ApsaraVideo VOD

    • 1: OSS

    Valores válidos:

    • 0 :

      VOD.

    • 1 :

      OSS.

    1
    FileInfo

    array<object>

    Não

    As informações de armazenamento de arquivos, usadas para especificar o formato, o local de armazenamento e a convenção de nomenclatura dos arquivos de gravação. Este parâmetro é válido apenas quando StorageType é definido como 1 (OSS).

    Nota

    Um arquivo de gravação é gerado para cada elemento na matriz 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 diferentes formatos de arquivo.

    Format

    string

    Sim

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

    • HLS

    • MP4

    • MP3

    Valores válidos:

    • MP4 :

      Formato MP4.

    • MP3 :

      Formato MP3.

    • HLS :

      Formato HLS.

    HLS
    FileNamePattern

    string

    Não

    A convenção de nomenclatura de arquivos. 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 fluxo misto. Se selecionado, a string {UserId} é mantida.

    • RecordMode

      • 0 corresponde a Single.

      • 1 corresponde a Mix.

    • SourceType

      • No modo de fluxo único, quando o tipo de fluxo é apenas vídeo, este parâmetro entra em vigor. Valores válidos:

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

        • 1 corresponde a S (Screen) para fluxos 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 é o fluxo original, este parâmetro entra em vigor. Valores válidos:

        • 0 corresponde a OC (Original Camera) para fluxos originais de câmera.

        • 1 corresponde a OS (Original Screen) para fluxos originais de compartilhamento de tela.

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

    • StreamType: Usa o parâmetro StreamType em RecordParams.

      • 0 corresponde a AV (Audio Video) para fluxos de áudio e vídeo.

      • 1 corresponde a A (Audio) para fluxos de áudio.

      • 2 corresponde a V (Video) para fluxos de vídeo.

    • StartTime: A hora em que a gravação começa. O fuso horário é UTC+8. O formato é semelhante a 2025-03-25-11:27:28. Obrigatório se o valor padrão não for usado.

    Valores padrão:

    • Modo de gravação de fluxo único

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

      • Se diferentes StreamTypes ou SourceTypes do mesmo UserId forem assinados ao mesmo tempo, o valor padrão é {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}.

    • Modo de gravação de fluxo misto

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

    Nota

    • A string pode consistir apenas nas variáveis anteriores. Os nomes das variáveis devem ser colocados entre chaves {} e separados por um sublinhado (_). Cada variável pode aparecer no máximo uma vez na string.

    • Se o nome for definido como xxx, o arquivo será salvo finalmente 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

    A convenção de nomenclatura de segmentos. Este parâmetro é válido apenas no formato HLS. É semelhante ao FileNamePattern, exceto que a variável Sequence também está disponível:

    • AppId

    • ChannelId

    • UserId: Obrigatório no modo de fluxo único. Inválido no modo de fluxo misto. Se selecionado, a string {UserId} é mantida.

    • RecordMode

      • 0 corresponde a Single.

      • 1 corresponde a Mix.

    • SourceType

      • No modo de fluxo único, este parâmetro entra em vigor quando o tipo de fluxo é apenas vídeo. Valores válidos:

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

        • 1 corresponde a S (Screen) para fluxos 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 é o fluxo original, este parâmetro entra em vigor. Valores válidos:

        • 0 corresponde a OC (Original Camera) para fluxos originais de câmera.

        • 1 corresponde a OS (Original Screen) para fluxos originais de compartilhamento de tela.

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

    • StreamType: Usa o parâmetro StreamType em RecordParams.

      • 0 corresponde a AV (Audio Video) para fluxos de áudio e vídeo.

      • 1 corresponde a A (Audio) para fluxos de áudio.

      • 2 corresponde a V (Video) para fluxos de vídeo.

    • StartTime: A hora em que a gravação começa. O fuso horário é UTC+8. O formato é semelhante a 2025-03-25-11:27:28. Obrigatório se o valor padrão não for usado.

    • Sequence: No formato HLS, o nome do arquivo .ts contém Sequence. Inválido em outros formatos. Obrigatório se o valor padrão não for usado.

    Valores padrão:

    • Modo de gravação de fluxo único

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

      • Se diferentes StreamTypes ou SourceTypes do mesmo UserId forem assinados ao mesmo tempo, o valor padrão é {AppId}_{ChannelId}_{UserId}_{SourceType}_{StartTime}_{Sequence}.

    • Modo de gravação de fluxo misto

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

    Nota

    • A string pode consistir apenas nas variáveis anteriores. Os nomes das variáveis devem ser colocados entre chaves {} e separados por um sublinhado (_). Cada variável pode aparecer no máximo uma vez na string.

    • Se o nome for definido como xxx, o arquivo de segmento será salvo finalmente 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 na matriz 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 no exemplo anterior será salvo diretamente como TaskId/xxx.m3u8.

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

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

    • Após a concatenação dos caminhos em todos os níveis na matriz, o comprimento total não pode exceder 128 caracteres (incluindo a '/' de conexão, mas excluindo o TaskId preenchido automaticamente). Por exemplo, se o valor do parâmetro for ["dir1","dir2"], o caminho concatenado é "dir1/dir2/", o que significa que a soma do número total de caracteres de todos os elementos na matriz e o comprimento da matriz (correspondente à "/" após cada nível de caminho) não deve exceder 128.

    • O número de elementos na matriz não pode exceder 5, o que significa que você pode personalizar até 5 níveis de caminhos.

    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. Valores válidos: 10 a 30. Valor padrão: 30.

    Recomendamos que você use o valor padrão, a menos que haja outros requisitos.

    30
    OSSParams

    object

    Não

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

    OSSEndpoint

    string

    Sim

    O endpoint do bucket do OSS. O ID da região correspondente deve ser o mesmo que o endpoint de registro de serviço selecionado.

    oss-cn-shanghai.aliyuncs.com
    OSSBucket

    string

    Sim

    O nome do bucket do OSS. O bucket deve pertencer à conta da Alibaba Cloud do chamador atual.

    mytest-bucket
    VodParams

    object

    Não

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

    Nota

    • A gravação no ApsaraVideo VOD não é suportada na região EUA (Virgínia).

    StorageLocation

    string

    Não

    O endereço de armazenamento incluído no console de vídeo sob demanda > Ativos de mídia > Gerenciamento de armazenamento. Os arquivos de gravação são salvos primeiro aqui e depois enviados para o vídeo sob demanda.

    Nota

    • Este parâmetro é obrigatório quando StorageType é definido como 0 (padrão de vídeo sob demanda).

    • Certifique-se de que a área do endereço de armazenamento seja a mesma que o endpoint de registro de serviço 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 é definido como 0 (padrão de vídeo sob demanda).

    • Certifique-se de que a área do ID do grupo de modelos de transcodificação seja a mesma que o endpoint de registro de serviço selecionado.

    ****8a914d3989e9825eb90530b2****
    AutoCompose

    integer

    Não

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

    • 0: Desativar mesclagem automática. (Padrão)

    • 1: Ativar mesclagem automática. Se este valor for definido, você deve definir o parâmetro ComposeVodTranscodeGroupId.

    Valores válidos:

    • 0 :

      Desativar mesclagem automática.

    • 1 :

      Ativar mesclagem automática. Se este valor for definido, você deve definir o parâmetro ComposeVodTranscodeGroupId.

    0
    ComposeVodTranscodeGroupId

    string

    Não

    O ID do grupo de modelos de transcodificação de vídeo sob demanda usado para transcodificar o vídeo recém-gerado no serviço de vídeo sob demanda após a mesclagem automática.

    Nota

    ****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 de fluxo misto.

    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 Kbit/s. Valores válidos: 8 a 500. Este parâmetro é obrigatório no modo de fluxo misto.

    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 fluxo misto.

    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 fluxo misto.

    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 Kbit/s. Valores válidos: 1 a 10000. No modo de fluxo misto, este parâmetro é obrigatório se você quiser que a saída de gravação inclua vídeo. É inválido em outros casos.

    5000
    VideoFramerate

    integer

    Não

    A taxa de quadros de vídeo, em fps. Valores válidos: 1 a 60. No modo de fluxo misto, este parâmetro é obrigatório se você quiser que a saída de gravação inclua vídeo. É inválido em outros casos.

    30
    VideoGop

    integer

    Não

    O grupo de imagens (GOP) de vídeo. Existe um I-frame a cada VideoGop quadros. Valores válidos: 1 a 60. No modo de fluxo misto, este parâmetro é obrigatório se você quiser que a saída de gravação inclua vídeo. É inválido em outros casos.

    30
    VideoHeight

    integer

    Não

    A altura do vídeo, em pixels. Valores válidos: 0 a 1920. Valor padrão: 0.

    480
    VideoWidth

    integer

    Não

    A largura do vídeo, em pixels. Valores válidos: 0 a 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 de fluxo misto se você quiser gerar um arquivo não exclusivo de áudio.

    MixBackground

    object

    Não

    A imagem de fundo global para gravação de fluxo misto.

    RenderMode

    integer

    Não

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

    • 0: Cortar. (Padrão)

    • 1: Dimensionar e exibir com fundo preto.

    Valores válidos:

    • 0 :

      Cortar.

    • 1 :

      Dimensionar e exibir com fundo preto.

    0
    Url

    string

    Não

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

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

    array<object>

    Não

    Especifica as informações de layout de janela para os usuários inscritos. Apenas os usuários cujo UserId tem informações de layout configuradas são exibidos no vídeo. Este parâmetro é obrigatório quando a mixagem de fluxo está ativada e a gravação não é um arquivo de áudio puro.

    array<object>

    Não

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

    UserId

    string

    Não

    O UserId correspondente à janela.

    • Se o UserId não for especificado, as janelas serão preenchidas na ordem em que os usuários inscritos entrarem no canal.

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

    • Fluxos de áudio puro inscritos não podem ser adicionados ao layout.

    userA
    SourceType

    integer

    Não

    O tipo de fluxo de entrada de vídeo do UserId. Se o UserId não for especificado, a configuração de SourceType aqui será inválida. 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 indica a camada inferior, 1 indica a camada acima de 0, e assim por diante. Valor padrão: 0.

    0
    SubBackground

    object

    Não

    A imagem de fundo da subimagem. Quando um usuário desliga a câmera, não realiza a ingestão de um fluxo após entrar no canal 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 quando a subimagem é gerada. Valores válidos:

    • 0: Cortar. (Padrão)

    • 1: Dimensionar e exibir com um fundo preto.

    Valores válidos:

    • 0 :

      Cortar.

    • 1 :

      Dimensionar e exibir com fundo preto.

    0
    Url

    string

    Não

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

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

    string

    Não

    A URL que recebe mensagens de callback. As mensagens de status da tarefa são enviadas para esta URL no formato JSON usando o método POST. O comprimento máximo é de 2048 caracteres.

    Para obter mais informações sobre mensagens de callback, consulte a documentação.

    http://xxxx/test/mycallback
    NotifyAuthKey

    string

    Não

    A chave de autenticação para mensagens de callback. Por padrão, este parâmetro é deixado vazio, o que significa que nenhuma autenticação é realizada. Se especificado, o comprimento deve ser de 16 a 64 caracteres e pode conter apenas letras maiúsculas e minúsculas e dígitos.

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

    • Se um NotifyAuthKey válido for especificado, as informações de autenticação serão incluídas nas mensagens de callback.

    mytestkeymytestkey
    NotifyFileUploadedFormat

    array

    Não

    Os formatos especificados. Quando um evento de geração de arquivo de gravação (RecordFileUploaded) é acionado, uma mensagem de callback é enviada.

    string

    Não

    Os formatos de arquivo específicos para os quais os callbacks são recebidos. 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, os formatos selecionados devem estar incluídos nos formatos de arquivo de StorageParams.FileInfo.

    MP4
    MaxIdleTime

    integer

    Não

    O período de tempo limite de ociosidade. Se a tarefa permanecer ociosa por uma duração que exceda MaxIdleTime, a tarefa será interrompida automaticamente. Unidade: segundos. Valores válidos: 10 a 14400, que é um máximo de 4 horas. Valor padrão: 300.

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

    • No modo de gravação de fluxo único, os fluxos inscritos são independentes uns dos outros. Se qualquer fluxo interromper a ingestão, ele será considerado ocioso. Após MaxIdleTime ser atingido, a gravação deste fluxo é interrompida. Quando todos os fluxos inscritos atingirem o tempo limite devido à ociosidade, toda a tarefa de gravação em nuvem será interrompida.

    600

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

      • Você pode se inscrever tanto na câmera quanto no compartilhamento de tela do mesmo UserId ao mesmo tempo. No entanto, os parâmetros FileNamePattern e SliceNamePattern devem conter a variável SourceType para evitar que os arquivos de gravação se sobrescrevam.

      • A inscrição apenas no fluxo de vídeo puro de um UserId específico não é suportada. Ou seja, no modo de fluxo único, o valor de UserInfo.StreamType não pode ser definido como 2.

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

      • Se RecordParams.StreamType for um fluxo de áudio puro (valor: 1), SubscribeParams não poderá conter inscrições para fluxos de vídeo puro (ou seja, o valor de SubscribeParams não pode ser 2).

      • Se RecordParams.StreamType for um fluxo de vídeo puro (valor: 2), SubscribeParams não poderá conter inscrições para fluxos de áudio puro (ou seja, o valor de SubscribeParams não pode ser 1).

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

      • Se RecordParams.StreamType for um fluxo de áudio puro (valor: 1), nem todos os UserIds em SubscribeParams podem se inscrever apenas em fluxos de vídeo puro (ou seja, os valores de todos os SubscribeParams não podem ser 2).

      • Se RecordParams.StreamType for um fluxo de vídeo puro (valor: 2), nem todos os UserIds em SubscribeParams podem se inscrever apenas em fluxos de áudio puro (ou seja, os valores de todos os SubscribeParams não podem ser 1).

    • Durante a gravação, se o canal for fechado no meio do caminho, você deve entrar novamente no canal e iniciar a ingestão de fluxo dentro do período de tempo limite de ociosidade. Caso contrário, a tarefa será interrompida automaticamente.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O conteúdo da 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 parâmetro 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 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. O parâmetro ChannelId é inválido. Verifique o parâmetro.
    404 InvalidParameter.AppId %s, please check the appId. O parâmetro AppId é inválido. Verifique o parâmetro.
    405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams. O parâmetro VodParams contém campos inválidos. Verifique o parâmetro.
    405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey. O formato do parâmetro NotifyAuthKey é inválido. Verifique o parâmetro.
    405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime. O parâmetro MaxIdleTime é inválido. Verifique o parâmetro.
    405 InvalidParameter.RecordParams %s, please check the recordParams. O parâmetro RecordParams contém campos inválidos. Verifique o parâmetro.
    405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. O parâmetro StorageType é inválido. Verifique o parâmetro.
    405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. O parâmetro NotifyFileUploadedFormat é inválido. Verifique o parâmetro.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.