Especifica um fluxo. Um fluxo é uma representação de um fluxo publicado em uma sessão. Quando um cliente chama a função Método Session.publish(), um novo fluxo é criado. As propriedades do objeto Stream fornecem informações sobre o fluxo.

Quando um fluxo é adicionado a uma sessão, o objeto Session dispara um streamCreatedEvent. Quando um fluxo é destruído, o objeto Session dispara um streamDestroyed evento. O objeto StreamEvent, que define esses objetos de evento, possui um stream propriedade, que é uma matriz de objetos Stream. Para obter mais detalhes e um exemplo de código, consulte StreamEvent.

Quando é estabelecida uma conexão com uma sessão, o objeto Session dispara um sessionConnected evento, definido pelo objeto SessionConnectEvent. O objeto SessionConnectEvent possui um streams propriedade, que é uma matriz de objetos Stream relacionados aos fluxos presentes na sessão naquele momento. Para obter mais detalhes e um exemplo de código, consulte SessionConnectEvent.

Propriedades

Nome Tipo Descrição
connection Conexão O objeto `Connection` correspondente à conexão que está publicando o fluxo. Você pode comparar isso com o connection propriedade do objeto Session para verificar se o fluxo está sendo publicado pela página da web local.
creationTime Número O carimbo de data/hora da criação do fluxo. Esse valor é calculado em milissegundos. É possível converter esse valor em um objeto Date chamando new Date(creationTime), onde creationTime é o creationTime propriedade do objeto Stream.
frameRate Número A taxa de quadros alvo para captura do editor. Inicialmente derivada do frameRate propriedade passada para OT.initPublisher(). Essa propriedade só é definida se o editor especificar explicitamente uma taxa de quadros; caso contrário, ela é indefinida. Esse valor é atualizado quando o editor chama Publisher.setPreferredFrameRate(). Observação: Esse valor representa a taxa de quadros-alvo atual do emissor, e não a taxa de quadros efetivamente codificada ou recebida por um assinante. A taxa de quadros codificada ainda pode ser menor devido a restrições de largura de banda ou da CPU, e a taxa de quadros recebida pode variar ainda mais dependendo das condições da rede. Para obter a taxa de quadros decodificada real para um assinante, use o video.decodedFrameRate propriedade retornada por Subscriber.getStats().
hasCaptions Booleano Se a transmissão possui legendas. Essa propriedade pode mudar caso o editor ative ou desative as legendas (chamando a função Publisher.publishCaptions() método). Quando isso ocorre, o Sessão o objeto despacha um streamPropertyChanged evento (ver StreamPropertyChangedEvent).
hasAudio Booleano Se o stream possui áudio. Essa propriedade pode mudar se o editor ativar ou desativar o áudio (chamando Publisher.publishAudio()). Quando isso ocorre, o Sessão o objeto despacha um streamPropertyChanged evento (ver StreamPropertyChangedEvent).
hasVideo Booleano Se a transmissão contém vídeo. Essa propriedade pode mudar se o emissor ativar ou desativar o vídeo (chamando Publisher.publishVideo()). Quando isso ocorre, o Sessão o objeto despacha um streamPropertyChanged evento (ver StreamPropertyChangedEvent).
initials String As iniciais da transmissão. Os editores podem especificar as iniciais a serem exibidas quando o vídeo estiver desativado. (Consulte o initials propriedade do properties parâmetro passado para o OT.initPublisher() método.)
name String O nome da transmissão. Os editores podem especificar um nome ao publicar uma transmissão (usando o publish() método do objeto Session do editor).
streamId String O ID exclusivo do stream.
videoDimensions Objeto Este objeto possui duas propriedades: width e height (ambos os números). Eles representam a resolução-alvo de captura do editor, conforme sinalizada pela última vez à sessão. O valor é transmitido a todos os participantes por meio da camada de sinalização e pode ser lido tanto pelos clientes editores quanto pelos assinantes. O valor é definido inicialmente a partir do resolution propriedade passada para OT.initPublisher(). É atualizado em tempo de execução quando o editor local <video> o elemento detecta uma alteração na dimensão (por exemplo, após uma chamada para Publisher.setPreferredResolution(), o redimensionamento de uma janela de compartilhamento de tela ou a rotação de um dispositivo móvel). Observação: Esses valores representam a resolução-alvo de captura do editor, e não a resolução efetivamente codificada ou recebida por um assinante. O editor pode codificar em uma resolução inferior devido a restrições de largura de banda ou de CPU, e os assinantes que utilizam vídeo escalável podem receber uma camada com resolução ainda menor. Para obter a resolução efetivamente decodificada no cliente assinante, use Subscriber.videoWidth() e Subscriber.videoHeight(). Quando essa propriedade é alterada, o Sessão o objeto despacha um streamPropertyChanged evento (ver StreamPropertyChangedEvent).
videoType String O tipo de vídeo — seja "camera", "screen", ou "custom". A "screen" O vídeo utiliza o compartilhamento de tela no editor como fonte de vídeo; para outros vídeos, essa propriedade está definida como "camera". A "custom" O vídeo utiliza um elemento VideoTrack como fonte de vídeo no editor. (Consulte o videoSource propriedade do options parâmetro passado para o OT.initPublisher() método.) O videoType é undefined quando uma transmissão é apenas de voz (consulte o Guia apenas por voz). Essa propriedade pode mudar se uma transmissão publicada a partir de um dispositivo móvel passar de um tipo de vídeo de câmera para um tipo de vídeo de compartilhamento de tela. Quando o tipo de vídeo muda, o Sessão o objeto despacha um streamPropertyChanged evento (ver StreamPropertyChangedEvent).