Salas RTC e Web SDK
Fluxo de integração
Seção intitulada “Fluxo de integração”- Crie um projeto e uma chave com escopo no Console do RTC.
- Seu backend cria uma sala utilizando o servidor API.
- Seu aplicativo autentica um usuário e verifica sua participação na sala.
- Seu backend solicita as credenciais dos participantes para aquela sala autorizada.
- O cliente se conecta com essas credenciais e publica a mídia, se permitido.
- Seu backend encerra a sala quando a sessão terminar.
Seus usuários finais não recebem a chaveAPI do projeto. Você continua sendo responsável pela identidade, associação, consentimento e interface do usuário do aplicativo.
Crie uma sala a partir de seu backend
Seção intitulada “Crie uma sala a partir de seu backend”# Replace the sample UUID with the project ID copied from your console.curl --fail-with-body \ --request POST https://api.rtc.champrep.com/v1/rooms \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"00000000-0000-4000-8000-000000000001","name":"Product support","maxParticipants":4}'Salve o retorno id na gravação da sala do seu aplicativo. maxParticipants
deve atender tanto à restriçãoAPI atual quanto à cota do plano ativo. Não repita automaticamente a criação da sala após um tempo limite ambíguo: a primeira solicitação pode ter sido bem-sucedida. Verifique a lista primeiro.
Obter as credenciais dos participantes
Seção intitulada “Obter as credenciais dos participantes”Após verificar o acesso do usuário, seu backend envia:
curl --fail-with-body \ --request POST "https://api.rtc.champrep.com/v1/rooms/$RTC_ROOM_ID/tokens" \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"canPublish":true}'A resposta contém token, participantId, expiresIn, url, e
iceServers. Transmita esse conjunto de credenciais ao cliente autorizado por meio de seu próprio endpoint autenticado, com o cache desativado. Trate todas elas como informações confidenciais. As credenciais expiram após cinco minutos para a adesão e não podem ser reutilizadas após uma adesão bem-sucedida. Isso não significa que a duração máxima da chamada seja de cinco minutos.
Navegador SDK
Seção intitulada “Navegador SDK”Utilize a distribuiçãoSDK Web em JavaScript/TypeScript compatível.
Contato CHAMPREP para acesso ao pacote e instruções de instalação. Não instale um pacote de terceiros com nome semelhante. O exemplo a seguir pressupõe que você já tenha o RtcSession
classe em seu aplicativo. Seu caminho de importação depende dessa distribuição.
const session = new RtcSession();
session.addEventListener('state', (event) => { updateConnectionLabel((event as CustomEvent).detail);});session.addEventListener('track', (event) => { const { id, stream, kind } = (event as CustomEvent).detail; attachRemoteMedia(id, stream, kind);});session.addEventListener('trackremoved', (event) => { removeRemoteMedia((event as CustomEvent).detail);});session.addEventListener('localtrack', (event) => { showLocalPreview((event as CustomEvent).detail);});session.addEventListener('error', (event) => { showCallError((event as CustomEvent).detail);});
await session.connect(async () => { // Your server authenticates this session and authorizes its room membership. // Implement CSRF protection appropriate to your application's session model. const response = await fetch('/your-app/rtc/join', { method: 'POST', credentials: 'same-origin', cache: 'no-store', }); if (!response.ok) throw new Error('Unable to join this room'); return response.json();});
// Call from your application's explicit microphone/camera consent flow.await session.publish(true);
// Call when leaving or unmounting the call screen.// session.close();As funções para renderização de mídia e erros são espaços reservados específicos do aplicativo . Anexe cada fluxo retornado ao elemento de áudio ou vídeo apropriado , silencie sua pré-visualização local, defina playsInline para vídeo e lide com a rejeição da reprodução automática por meio de um controle “Reproduzir” acionado pelo usuário. Uma faixa de áudio remota requer um elemento compatível com áudio, mesmo quando não há vídeo.
SDK controles
Seção intitulada “SDK controles”| Método | Comportamento |
|---|---|
connect(tokenProvider) | Conecte-se usando uma função que retorne novas credenciais |
publish(true) | Solicite o microfone e a câmera e publique suas faixas |
publish(false) | Publique o áudio do microfone sem o vídeo da câmera |
setMuted(true) / setMuted(false) | Silenciar ou ativar o som do produtor do microfone |
setCamera(false) / setCamera(true) | Desative ou ative o produtor da câmera |
shareScreen() | Abra o seletor do navegador e publique um registro de tela apenas com vídeo |
setReceiveQuality('low') | Solicite vídeo recebido de qualidade inferior |
setReceiveQuality('auto') | Restaurar as preferências normais de vídeo recebido |
close() | Saída, encerramento de transportes e liberação de faixas capturadas |
Não chame publish para um participante apenas de recepção. Evite ações duplicadas de publicação em sua interface de usuário. O áudio da tela não é capturado por este recursoAPI. Para interromper o compartilhamento, utilize o controle “Interromper compartilhamento” do navegador. Silenciar não é o mesmo que sair; chamada close() para liberar a sessão e seus dispositivos capturados.
Alterações na rede e ciclo de vida
Seção intitulada “Alterações na rede e ciclo de vida”O tentaSDK a reconexão após interrupções de sinalização e utiliza a função do provedor de tokens novamente. Sempre emita um novo token após verificar o acesso; nunca armazene em cache um token consumido. A reconexão é limitada e pode falhar. Exiba os estados de conexão e de erro e ofereça um fluxo de reconexão controlado pelo usuário.
O modo de baixa largura de banda reduz a qualidade do vídeo recebido; ele não pode garantir uma chamada em uma conexão inutilizável. Considere a publicação apenas de áudio quando for apropriado. O tambémSDK aceita new RtcSession({ iceTransportPolicy: 'relay' }) para conexões exclusivamente de retransmissão, que exigem um serviço de retransmissão acessível.
Teste dispositivos reais, permissões do navegador, redes restritas, execução em segundo plano, compartilhamento de tela e comportamento de reconexão antes do lançamento. Os guias de Python, Node.js SDKs e MEAN/MERN/MEN permanecem itens do roadmap.