INTEGRITY Документация

← Cloudflare Realtime / realtime / realtimekit / core

Метаданные встречи

Все метаданные, связанные со встречей, хранятся в meeting.meta. Сюда входит важная информация о состоянии встречи, ее типе и подключениях.

Доступные метаданные

Выберите фреймворк в зависимости от платформы, для которой вы разрабатываете приложение.

meeting.meta объект содержит следующие свойства:

viewType - Указывает тип встречи. Возможные значения: WEBINAR, GROUP_CALL
roomType - Указывает, является ли встреча групповым звонком или вебинаром
meetingTitle - Название встречи
meetingStartedTimestamp - Временная метка начала встречи
mediaState - Состояние медиасоединения
socketState - Состояние сокет-соединения

meeting.meta объект содержит следующие свойства:

viewType - Указывает тип встречи. Возможные значения: WEBINAR, GROUP_CALL
roomType - Указывает, является ли встреча групповым звонком или вебинаром
meetingTitle - Название встречи
meetingStartedTimestamp - Временная метка начала встречи
mediaState - Состояние медиасоединения
socketState - Состояние сокет-соединения

meeting.meta объект содержит следующие свойства:

meetingId - Уникальный идентификатор встречи
meetingTitle - Название встречи
meetingStartedTimestamp - Временная метка начала встречи
meetingType - Указывает тип встречи, который может быть одним из следующих: GROUP_CALL, WEBINAR, AUDIO_ROOM, или LIVESTREAM из RtkMeetingType enum
meetingConfig - Конфигурация встречи, содержащая настройки аудио и видео
meetingState - Состояние встречи типа RtkMeetingState
authToken - Токен аутентификации пользователя для встречи
selfActiveTab - Информация о текущей активной вкладке локального участника
mediaConnectionState - Текущее состояние медиасоединения
socketConnectionState - Текущее состояние сокет-соединения

meeting.meta объект содержит следующие свойства:

meetingId - Уникальный идентификатор встречи
meetingTitle - Название встречи
meetingStartedTimestamp - Временная метка начала встречи
meetingType - Указывает тип встречи, который может быть одним из следующих: .groupCall, .webinar, .audioRoom, или .livestream из RtkMeetingType enum
meetingConfig - Конфигурация встречи, содержащая настройки аудио и видео
meetingState - Состояние встречи типа RtkMeetingState
authToken - Токен аутентификации пользователя для встречи
selfActiveTab - Информация о текущей активной вкладке локального участника
mediaConnectionState - Текущее состояние медиасоединения
socketConnectionState - Текущее состояние сокет-соединения

meeting.meta объект содержит следующие свойства:

viewType - Указывает тип встречи. Возможные значения: WEBINAR, GROUP_CALL
roomType - Указывает, является ли встреча групповым звонком или вебинаром
meetingTitle - Название встречи
meetingStartedTimestamp - Временная метка начала встречи
mediaState - Состояние медиасоединения
socketState - Состояние сокет-соединения

Доступ к метаданным встречи

Чтобы получить доступ к метаданным встречи, используйте meeting.meta объект.

// Destructure the metadata to get meetingTitle
const { meetingTitle } = meeting.meta;

if (meeting.self.roomJoined) {
	console.log(
		`The local user has joined a meeting with title ${meetingTitle}.`,
	);
}

import { useRealtimeKitSelector } from "@cloudflare/realtimekit-react";
import { useEffect } from "react";

function MeetingInfo() {
	const [meetingTitle, roomJoined] = useRealtimeKitSelector((m) => [
		m.meta.meetingTitle,
		m.self.roomJoined,
	]);

	useEffect(() => {
		if (roomJoined) {
			console.log(
				`The local user has joined a meeting with title ${meetingTitle}.`,
			);
		}
	}, [roomJoined, meetingTitle]);

	return null;
}

val meetingTitle = meeting.meta.meetingTitle

let meetingTitle = meeting.meta.meetingTitle

import { useRealtimeKitSelector } from "@cloudflare/realtimekit-react-native";
import { useEffect } from "react";

const [meetingTitle, roomJoined] = useRealtimeKitSelector((m) => [
	m.meta.meetingTitle,
	m.self.roomJoined,
]);

useEffect(() => {
	if (roomJoined) {
		console.log(
			`The local user has joined a meeting with title ${meetingTitle}.`,
		);
	}
}, [roomJoined, meetingTitle]);

События соединения

meta объект также генерирует события, указывающие на изменения состояния подключения встречи.

Обновления медиасоединения

Обновления медиасоединения (WebRTC-соединения, используемого для передачи самих медиаданных) отправляются через mediaConnectionUpdate событие.

meeting.meta.on("mediaConnectionUpdate", ({ transport, state }) => {
	// transport - 'consuming' | 'producing'
	// state - 'new' | 'connecting' | 'connected' | 'disconnected' | 'reconnecting' | 'failed'

	console.log(`Media connection ${transport} is now ${state}`);
});

mediaConnectionUpdate событие содержит:

transport - Либо 'consuming' (получение медиаданных) или 'producing' (отправка медиаданных)
state - Состояние соединения: 'new', 'connecting', 'connected', 'disconnected', 'reconnecting', или 'failed'

Обновления медиасоединения (WebRTC-соединения, используемого для передачи самих медиаданных) отправляются через mediaConnectionUpdate событие.

import { useRealtimeKitClient } from "@cloudflare/realtimekit-react";
import { useEffect } from "react";

function MediaConnectionMonitor() {
	const [meeting] = useRealtimeKitClient();

	useEffect(() => {
		if (meeting) {
			const handleMediaConnection = ({ transport, state }) => {
				// transport - 'consuming' | 'producing'
				// state - 'new' | 'connecting' | 'connected' | 'disconnected' | 'reconnecting' | 'failed'

				console.log(`Media connection ${transport} is now ${state}`);
			};

			meeting.meta.on("mediaConnectionUpdate", handleMediaConnection);

			return () => {
				meeting.meta.off("mediaConnectionUpdate", handleMediaConnection);
			};
		}
	}, [meeting]);

	return null;
}

mediaConnectionUpdate событие содержит:

transport - Либо 'consuming' (получение медиаданных) или 'producing' (отправка медиаданных)
state - Состояние соединения: 'new', 'connecting', 'connected', 'disconnected', 'reconnecting', или 'failed'

Текущее состояние медиасоединения можно получить прямо из метаданных.

val mediaConnectionState = meeting.meta.mediaConnectionState

Текущее состояние медиасоединения можно получить прямо из метаданных.

let mediaConnectionState = meeting.meta.mediaConnectionState

Обновления медиасоединения (WebRTC-соединения, используемого для передачи самих медиаданных) отправляются через mediaConnectionUpdate событие.

meeting.meta.on("mediaConnectionUpdate", ({ transport, state }) => {
	// transport - 'consuming' | 'producing'
	// state - 'new' | 'connecting' | 'connected' | 'disconnected' | 'reconnecting' | 'failed'

	console.log(`Media connection ${transport} is now ${state}`);
});

mediaConnectionUpdate событие содержит:

transport - Либо 'consuming' (получение медиаданных) или 'producing' (отправка медиаданных)
state - Состояние соединения: 'new', 'connecting', 'connected', 'disconnected', 'reconnecting', или 'failed'

Обновления подключения Socket

Обновления WebSocket-соединения (используемого для чата, опросов и другой базовой сигнализации) отправляются через socketConnectionUpdate событие.

meeting.meta.on(
	"socketConnectionUpdate",
	({ state, reconnectionAttempt, reconnected }) => {
		// state - 'connected' | 'disconnected' | 'reconnecting' | 'failed'

		console.log(`Socket connection is now ${state}`);

		if (reconnectionAttempt) {
			console.log(`Reconnection attempt: ${reconnectionAttempt}`);
		}

		if (reconnected) {
			console.log("Successfully reconnected");
		}
	},
);

socketConnectionUpdate событие содержит:

state - Состояние соединения: 'connected', 'disconnected', 'reconnecting', или 'failed'
reconnectionAttempt - Количество выполненных попыток переподключения (при переподключении)
reconnected - Логическое значение, указывающее, было ли соединение успешно восстановлено

Обновления WebSocket-соединения (используемого для чата, опросов и другой базовой сигнализации) отправляются через socketConnectionUpdate событие.

import { useRealtimeKitClient } from "@cloudflare/realtimekit-react";
import { useEffect } from "react";

function SocketConnectionMonitor() {
	const [meeting] = useRealtimeKitClient();

	useEffect(() => {
		if (meeting) {
			const handleSocketConnection = ({
				state,
				reconnectionAttempt,
				reconnected,
			}) => {
				// state - 'connected' | 'disconnected' | 'reconnecting' | 'failed'

				console.log(`Socket connection is now ${state}`);

				if (reconnectionAttempt) {
					console.log(`Reconnection attempt: ${reconnectionAttempt}`);
				}

				if (reconnected) {
					console.log("Successfully reconnected");
				}
			};

			meeting.meta.on("socketConnectionUpdate", handleSocketConnection);

			return () => {
				meeting.meta.off("socketConnectionUpdate", handleSocketConnection);
			};
		}
	}, [meeting]);

	return null;
}

socketConnectionUpdate событие содержит:

state - Состояние соединения: 'connected', 'disconnected', 'reconnecting', или 'failed'
reconnectionAttempt - Количество выполненных попыток переподключения (при переподключении)
reconnected - Логическое значение, указывающее, было ли соединение успешно восстановлено

Текущее состояние соединения сокета можно получить прямо из метаданных.

val socketConnectionState = meeting.meta.socketConnectionState

Текущее состояние соединения сокета можно получить прямо из метаданных.

let socketConnectionState = meeting.meta.socketConnectionState

Обновления WebSocket-соединения (используемого для чата, опросов и другой базовой сигнализации) отправляются через socketConnectionUpdate событие.

meeting.meta.on(
	"socketConnectionUpdate",
	({ state, reconnectionAttempt, reconnected }) => {
		// state - 'connected' | 'disconnected' | 'reconnecting' | 'failed'

		console.log(`Socket connection is now ${state}`);

		if (reconnectionAttempt) {
			console.log(`Reconnection attempt: ${reconnectionAttempt}`);
		}

		if (reconnected) {
			console.log("Successfully reconnected");
		}
	},
);

socketConnectionUpdate событие содержит:

state - Состояние соединения: 'connected', 'disconnected', 'reconnecting', или 'failed'
reconnectionAttempt - Количество выполненных попыток переподключения (при переподключении)
reconnected - Логическое значение, указывающее, было ли соединение успешно восстановлено

Следующие шаги

Связанные темы:

Разбор объекта встречи - Исчерпывающее описание объекта встречи
Жизненный цикл сессии - Изучение состояний встречи и переходов между ними