Pular para o conteúdo principal
O Stream Blueprint envia um evento de uso ao Dodo Payments com o número de bytes que um cliente consumiu de um stream. Um medidor Sum sobre bytes soma a largura de banda de cada cliente para que você possa cobrá-la. O blueprint é incluído no pacote npm @dodopayments/ingestion-blueprints como trackStreamBytes().

Casos de uso

O Stream Blueprint é adequado para os seguintes cenários:

Video Platforms

Cobre os clientes pelo consumo de largura de banda de vídeo e pela qualidade do streaming.

Music Streaming

Acompanhe o uso de streaming de áudio por usuário para níveis de assinatura.

Live Events

Monitore o consumo de transmissões ao vivo e cobre pelo uso da largura de banda.

Real-Time Data

Acompanhe a transferência de dados em tempo real para aplicações de IoT e telemetria.
Use-o em plataformas de streaming de vídeo e áudio, serviços de transmissão ao vivo e aplicações de dados em tempo real.

Início rápido

Para acompanhar o uso de streaming, instale o pacote, crie um medidor e envie os bytes consumidos por cada cliente.
1

Install the SDK

Instale o pacote Dodo Payments Ingestion Blueprints:
2

Get Your API Keys

Crie uma chave de API do Dodo Payments em Developer → API Keys no painel do Dodo Payments e armazene-a na variável de ambiente DODO_PAYMENTS_API_KEY. Use uma chave de modo de teste enquanto estiver desenvolvendo. Uma chave de modo de teste funciona apenas com test_mode.
3

Create a Meter

No painel do Dodo Payments, acesse Products → Meters e clique em Create Meter. Defina estes campos:
  • Meter Name: um nome descritivo, como Stream Bandwidth.
  • Event Name: stream_consumption ou um nome escolhido por você. Ele deve corresponder exatamente a eventName no seu código (diferencia maiúsculas de minúsculas).
  • Aggregation Type: Sum, para somar os bytes transmitidos.
  • Over Property: bytes, para cobrar com base no uso da largura de banda.
  • Measurement Unit: a unidade exibida nas faturas, como bytes.
4

Track Stream Usage

Chame trackStreamBytes() com o cliente e o número de bytes consumidos:

Configuração

Configuração de ingestão

Passe estas opções para new Ingestion():
string
obrigatório
Sua chave de API do Dodo Payments obtida no painel.
string
Modo do ambiente: test_mode ou live_mode. O padrão é test_mode. Os SDKs do Dodo Payments usam live_mode por padrão; portanto, defina live_mode explicitamente em produção.
string
obrigatório
Nome do evento que corresponde ao Event Name do seu medidor (diferencia maiúsculas de minúsculas).

Opções de acompanhamento de bytes do stream

Passe estas opções para trackStreamBytes():
string
obrigatório
O ID do cliente do Dodo Payments a ser cobrado pelo stream, por exemplo, cus_123.
number
Número de bytes consumidos no stream. Obrigatório para cobrança baseada em largura de banda. Se você omiti-lo, o evento não terá um valor bytes, mas ainda será contabilizado em um medidor Count.
object
Metadados opcionais sobre o stream, como tipo de stream, qualidade ou ID da sessão. Cada valor deve ser uma string, um número ou um booleano.

Práticas recomendadas

Acompanhe por bloco: para streams longos, acompanhe o consumo em blocos em vez de esperar a conclusão de todo o stream.
Cada chamada a trackStreamBytes() envia um evento separado, e um medidor Sum soma os blocos.
Contagem precisa de bytes: se você cobra pela largura de banda total, inclua toda a sobrecarga, como cabeçalhos e sobrecarga de protocolo, na contagem de bytes.
Última modificação em 26 de setembro de 2026