SDK de transmisión de IVS: intercambio de tokens | Transmisión en tiempo real

El intercambio de tokens le permite mejorar o reducir las capacidades de los tokens participantes y actualizar los atributos de los tokens en el SDK de transmisión, sin necesidad de que los participantes se vuelvan a conectar. Esto es útil en situaciones como el coalojamiento, en las que los participantes pueden comenzar con capacidades solo de suscripción y posteriormente necesitar capacidades de publicación.

El intercambio de tokens es compatible con los SDK de transmisión móvil y web. Cuando un participante intercambia un token, la composición del servidor detecta los atributos actualizados en tiempo real y ajusta automáticamente el diseño (por ejemplo, reasignando el espacio destacado, reordenando los participantes o moviendo a un participante a la superposición de imagen en imagen) sin necesidad de volver a conectarse.

Limitación: el intercambio de tokens solo funciona con tokens creados en su servidor mediante un par de claves. No funciona con los tokens creados a través de la API CreateParticipantToken.

Intercambio de tokens

El intercambio de tokens es sencillo: llame a la API exchangeToken del objeto Stage / IVSStage y proporciona el nuevo token. Si las capabilities del nuevo token son diferentes a las del token anterior, las capacidades del nuevo token se evalúan inmediatamente. Por ejemplo, si el token anterior no tenía la capacidad publish y el nuevo sí, se invocan las funciones de la estrategia de escenario para la publicación, lo que permite a la aplicación anfitriona decidir si quiere publicar de inmediato con la nueva capacidad o esperar. Lo mismo ocurre con las capacidades eliminadas: si el token anterior tenía la capacidad publish y el nuevo no, el participante anula de inmediato la publicación sin invocar las funciones de estrategia de la fase de publicación.

Al intercambiar un token, el token anterior y el nuevo deben tener los mismos valores para los siguientes campos de carga útil:

Estos campos son inmutables. Si se intercambia un token que modifica un campo inmutable, el SDK rechaza de manera inmediata el intercambio.

Los campos restantes se pueden cambiar, incluidos:

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);

Recepción de actualizaciones

Una función en StageRenderer / IVSStageRenderer recibe actualizaciones sobre los participantes remotos ya publicados que intercambian sus tokens para actualizar su userId o attributes. Los participantes remotos que aún no publiquen expondrán sus userId y attributes actualizados a través de las funciones de renderizado onParticipantJoined / participantDidJoin existentes si finalmente publican

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 
    }
);

Visibilidad de actualizaciones

Cuando un participante intercambia un token para actualizar su userId o attributes, la visibilidad de estos cambios depende de su estado de publicación actual:

Esta tabla aclara la matriz de soporte: