SDK de transmissão do IVS: troca de tokens | streaming em tempo real

A troca de tokens permite fazer o upgrade ou o downgrade dos recursos de token do participante e a atualização dos atributos de token no SDK de transmissão, sem que os participantes precisem se reconectar. Isso é útil em cenários como co-hospedagem, em que os participantes podem começar com recursos somente para assinantes e, posteriormente, precisarem de recursos de publicação.

A troca de tokens é compatível com os SDKs de transmissão móvel e web. Quando um participante troca um token, a composição do servidor detecta em tempo real os atributos atualizados e ajusta automaticamente o leiaute; por exemplo, reatribuindo o espaço em destaque, reordenando os participantes ou movendo um participante para a sobreposição picture-in-picture, sem necessidade de reconexão.

A troca de tokens funciona apenas com os tokens criados no servidor usando um par de chaves. Ela não funciona com tokens criados por meio da API CreateParticipantToken.

Troca de tokens

A troca de tokens é simples: chame a API exchangeToken no objeto Stage/IVSStage e forneça o novo token. Se os capabilities do novo token forem diferentes dos do token anterior, os recursos do novo token serão avaliados imediatamente. Por exemplo, se o token anterior não tiver o recurso publish e o novo token tiver, as funções de estratégia de estágio para publicação serão invocadas, permitindo que a aplicação de host decida se deseja publicar imediatamente com o novo recurso ou esperar. O mesmo vale para os recursos removidos: se o token anterior tinha a capacidade publish e o novo token não, o participante imediatamente cancela a publicação sem invocar as funções de estratégia de palco para publicação.

Ao trocar um token, o token anterior e o novo devem ter os mesmos valores para os seguintes campos de carga útil:

Esses campos são imutáveis. A troca de um token que modifica um campo imutável faz com que o SDK rejeite imediatamente a troca.

Os campos restantes podem ser alterados, incluindo:

iOS

let stage = try IVSStage(token: originalToken, strategy: self)
stage.join()
stage.exchangeToken(newToken)

Android

val stage = Stage(context, originalToken, strategy)
stage.join()
stage.exchangeToken(newToken)

Web

const stage = new Stage(originalToken, strategy);
await stage.join();
await stage.exchangeToken(newToken);

Receber atualizações

Uma função em StageRenderer/IVSStageRenderer recebe atualizações sobre participantes remotos já publicados que trocam seus tokens para atualizar seu userId ou attributes. Participantes remotos que ainda não estão publicando terão seus userId e attributes atualizados expostos por meio das funções de renderizador onParticipantJoined/participantDidJoinexistentes se eventualmente publicarem.

iOS

class MyStageRenderer: NSObject, IVSStageRenderer {
    func stage(_ stage: IVSStage, participantMetadataDidUpdate participant: IVSParticipantInfo) {
        // participant will be a new IVSParticipantInfo instance with updated properties.
    }
}

Android

private val stageRenderer = object : StageRenderer {
    override fun onParticipantMetadataUpdated(stage: Stage, participantInfo: ParticipantInfo) {
        // participantInfo will be a new ParticipantInfo instance with updated properties.
    }
}

Web

stage.on(StageEvents.STAGE_PARTICIPANT_METADATA_CHANGED, (participantInfo: StageParticipantInfo) => { 
    // participantInfo properties will be updated with the changed properties 
    }
);

Visibilidade das atualizações

Quando um participante troca um token para atualizar seu userId ou attributes, a visibilidade dessas alterações depende do estado atual de publicação:

Esta tabela esclarece a matriz de suporte: