fcr-core
Version:
Core APIs for building online scenes
1,061 lines (1,060 loc) • 40.9 kB
TypeScript
import { FcrLanguage } from './room-control/interpreter-control/types';
import { FcrPermissionAction, FcrPrivilegeUserRole, FcrSecurityAction } from './room-control/privilege-control/type';
import { FcrIPConnectorSessionType } from './room-control/room-connector-control/type';
import { FcrUserKickedOutType, FcrUserRole } from './room-control/user-control/type';
import { FcrBoardToolType } from './room-control/whiteboard-control-v2/enum';
import { FcrChatRoomMessageType } from './room-control/chatroom-control/type';
import { AgoraRtcAudioSourceType, AgoraRtcCapability, AgoraRtcEncryptionMode, AgoraRtcLatencyLevelType, AgoraRtcMediaSourceState, AgoraRtcRenderMode, AgoraRtcVideoStreamType, AgoraRteMediaStreamType, AgoraRteVideoSourceType, z, AgoraRteStreamPrivilegeOperation, AgoraRteStreamPrivilegeAudioSourceType, AgoraRteStreamPrivilegeVideoSourceType, FcrScreenScenarioType } from './imports';
import { FcrDeviceType } from './media-control/type';
import { FcrLineType } from './room-control/type';
export { anySchema, booleanSchema, createRecordSchemaWithKey, numberSchema, stringSchema, unknownSchema, fcrRenderViewSchema, createUnionSchema, createArraySchema, z, } from './imports';
export declare const stringOrObjectSchema: z.ZodTypeAny;
export declare const stringArraySchema: z.ZodArray<z.ZodString, "many">;
export declare const unknownArraySchema: z.ZodArray<z.ZodUnknown, "many">;
export declare const stringKeyUnknownValueSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
export declare const stringKeyNumberValueSchema: z.ZodRecord<z.ZodString, z.ZodNumber>;
export declare const fcrStreamPrivilegeOperation: z.ZodNativeEnum<typeof AgoraRteStreamPrivilegeOperation>;
export declare const fcrSecurityActionSchema: z.ZodNativeEnum<typeof FcrSecurityAction>;
export type FcrSecurityActionSchema = z.infer<typeof fcrSecurityActionSchema>;
export declare const fcrPermissionActionSchema: z.ZodNativeEnum<typeof FcrPermissionAction>;
export type FcrPermissionActionSchema = z.infer<typeof fcrPermissionActionSchema>;
export declare const fcrPrivilegeUserRoleSchema: z.ZodNativeEnum<typeof FcrPrivilegeUserRole>;
export type FcrPrivilegeUserRoleSchema = z.infer<typeof fcrPrivilegeUserRoleSchema>;
export declare const fcrLineTypeSchema: z.ZodNativeEnum<typeof FcrLineType>;
export type FcrLineTypeSchema = z.infer<typeof fcrLineTypeSchema>;
export declare const fcrUserRoleSchema: z.ZodNativeEnum<typeof FcrUserRole>;
export type FcrUserRoleSchema = z.infer<typeof fcrUserRoleSchema>;
export declare const fcrUserKickedOutTypeSchema: z.ZodNativeEnum<typeof FcrUserKickedOutType>;
export type FcrUserKickedOutTypeSchema = z.infer<typeof fcrUserKickedOutTypeSchema>;
export declare const fcrBoardToolTypeSchema: z.ZodNativeEnum<typeof FcrBoardToolType>;
export type FcrBoardToolTypeSchema = z.infer<typeof fcrBoardToolTypeSchema>;
export declare const fcrLanguageSchema: z.ZodNativeEnum<typeof FcrLanguage>;
export type FcrLanguageSchema = z.infer<typeof fcrLanguageSchema>;
export declare const fcrIPConnectorSessionTypeSchema: z.ZodNativeEnum<typeof FcrIPConnectorSessionType>;
export type FcrIPConnectorSessionTypeSchema = z.infer<typeof fcrIPConnectorSessionTypeSchema>;
export declare const fcrDeviceTypeSchema: z.ZodNativeEnum<typeof FcrDeviceType>;
export type FcrDeviceTypeSchema = z.infer<typeof fcrDeviceTypeSchema>;
export declare const fcrChatRoomMessageTypeSchema: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
export type FcrChatRoomMessageTypeSchema = z.infer<typeof fcrChatRoomMessageTypeSchema>;
export declare const fcrMediaStreamTypeSchema: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
export type FcrMediaStreamTypeSchema = z.infer<typeof fcrMediaStreamTypeSchema>;
export declare const fcrVideoSourceTypeSchema: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
export type FcrVideoSourceTypeSchema = z.infer<typeof fcrVideoSourceTypeSchema>;
export declare const fcrMediaSourceStateSchema: z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>;
export type FcrMediaSourceStateSchema = z.infer<typeof fcrMediaSourceStateSchema>;
export declare const fcrCapabilitySchema: z.ZodNativeEnum<typeof AgoraRtcCapability>;
export type FcrCapabilitySchema = z.infer<typeof fcrCapabilitySchema>;
export declare const fcrRenderModeSchema: z.ZodNativeEnum<typeof AgoraRtcRenderMode>;
export type FcrRenderModeSchema = z.infer<typeof fcrRenderModeSchema>;
export declare const fcrEncryptionModeSchema: z.ZodNativeEnum<typeof AgoraRtcEncryptionMode>;
export type FcrEncryptionModeSchema = z.infer<typeof fcrEncryptionModeSchema>;
export declare const fcrLatencyLevelTypeSchema: z.ZodNativeEnum<typeof AgoraRtcLatencyLevelType>;
export type FcrLatencyLevelTypeSchema = z.infer<typeof fcrLatencyLevelTypeSchema>;
export declare const fcrAudioSourceTypeSchema: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
export type FcrAudioSourceTypeSchema = z.infer<typeof fcrAudioSourceTypeSchema>;
export declare const fcrVideoStreamTypeSchema: z.ZodNativeEnum<typeof AgoraRtcVideoStreamType>;
export type FcrVideoStreamTypeSchema = z.infer<typeof fcrVideoStreamTypeSchema>;
export declare const fcrStreamPrivilegeAudioSourceTypeSchema: z.ZodNativeEnum<typeof AgoraRteStreamPrivilegeAudioSourceType>;
export declare const fcrScreenScenarioTypeSchema: z.ZodNativeEnum<typeof FcrScreenScenarioType>;
export type FcrStreamPrivilegeAudioSourceTypeSchema = z.infer<typeof fcrStreamPrivilegeAudioSourceTypeSchema>;
export declare const fcrStreamPrivilegeVideoSourceTypeSchema: z.ZodNativeEnum<typeof AgoraRteStreamPrivilegeVideoSourceType>;
export type FcrStreamPrivilegeVideoSourceTypeSchema = z.infer<typeof fcrStreamPrivilegeVideoSourceTypeSchema>;
export declare const fcrUserRolesSchema: z.ZodArray<z.ZodNativeEnum<typeof FcrUserRole>, "many">;
export type FcrUserRolesSchema = z.infer<typeof fcrUserRolesSchema>;
export declare const fcrPrivilegeUserRoleArraySchema: z.ZodArray<z.ZodNativeEnum<typeof FcrPrivilegeUserRole>, "many">;
export type FcrPrivilegeUserRoleArraySchema = z.infer<typeof fcrPrivilegeUserRoleArraySchema>;
export declare const fcrLanguageConfigSchema: z.ZodObject<{
sourceLanguage: z.ZodNativeEnum<typeof FcrLanguage>;
targetLanguage: z.ZodOptional<z.ZodNativeEnum<typeof FcrLanguage>>;
}, "strip", z.ZodTypeAny, {
sourceLanguage: FcrLanguage;
targetLanguage?: FcrLanguage | undefined;
}, {
sourceLanguage: FcrLanguage;
targetLanguage?: FcrLanguage | undefined;
}>;
export type FcrLanguageConfigSchema = z.infer<typeof fcrLanguageConfigSchema>;
export declare const fcrSessionBaseSchema: z.ZodObject<{
sessionId: z.ZodString;
sessionKey: z.ZodString;
timestamp: z.ZodNumber;
duration: z.ZodNumber;
payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
senderId: z.ZodString;
interval: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
sessionId: string;
timestamp: number;
senderId: string;
interval: number;
}, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
sessionId: string;
timestamp: number;
senderId: string;
interval: number;
}>;
export type FcrSessionBaseSchema = z.infer<typeof fcrSessionBaseSchema>;
export declare const fcrInterpreterUsersParamsSchema: z.ZodObject<{
userId: z.ZodString;
sourceLanguage: z.ZodNativeEnum<typeof FcrLanguage>;
targetLanguage: z.ZodNativeEnum<typeof FcrLanguage>;
}, "strip", z.ZodTypeAny, {
userId: string;
sourceLanguage: FcrLanguage;
targetLanguage: FcrLanguage;
}, {
userId: string;
sourceLanguage: FcrLanguage;
targetLanguage: FcrLanguage;
}>;
export type FcrInterpreterUsersParamsSchema = z.infer<typeof fcrInterpreterUsersParamsSchema>;
export declare const fcrSecurityPrivateChatConfigSchema: z.ZodObject<{
host: z.ZodBoolean;
cohost: z.ZodBoolean;
participant: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
host: boolean;
cohost: boolean;
participant: boolean;
}, {
host: boolean;
cohost: boolean;
participant: boolean;
}>;
export type FcrSecurityPrivateChatConfigSchema = z.infer<typeof fcrSecurityPrivateChatConfigSchema>;
export declare const fcrSecuritySendChatPayloadSchema: z.ZodObject<{
public: z.ZodBoolean;
private: z.ZodObject<{
host: z.ZodBoolean;
cohost: z.ZodBoolean;
participant: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
host: boolean;
cohost: boolean;
participant: boolean;
}, {
host: boolean;
cohost: boolean;
participant: boolean;
}>;
}, "strip", z.ZodTypeAny, {
public: boolean;
private: {
host: boolean;
cohost: boolean;
participant: boolean;
};
}, {
public: boolean;
private: {
host: boolean;
cohost: boolean;
participant: boolean;
};
}>;
export type FcrSecuritySendChatPayloadSchema = z.infer<typeof fcrSecuritySendChatPayloadSchema>;
export declare const fcrPhoneConnectorSessionParamsSchema: z.ZodObject<{
phoneNumber: z.ZodString;
userName: z.ZodString;
phoneUserId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
userName: string;
phoneNumber: string;
phoneUserId?: string | undefined;
}, {
userName: string;
phoneNumber: string;
phoneUserId?: string | undefined;
}>;
export type FcrPhoneConnectorSessionParamsSchema = z.infer<typeof fcrPhoneConnectorSessionParamsSchema>;
export declare const fcrIPConnectorSessionParamsSchema: z.ZodObject<{
address: z.ZodString;
type: z.ZodNativeEnum<typeof FcrIPConnectorSessionType>;
}, "strip", z.ZodTypeAny, {
type: FcrIPConnectorSessionType;
address: string;
}, {
type: FcrIPConnectorSessionType;
address: string;
}>;
export type FcrIPConnectorSessionParamsSchema = z.infer<typeof fcrIPConnectorSessionParamsSchema>;
export declare const fcrRoomSessionParamsSchema: z.ZodObject<{
sessionKey: z.ZodString;
duration: z.ZodNumber;
payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
}, "strip", z.ZodTypeAny, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
}, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
}>;
export type FcrRoomSessionParamsSchema = z.infer<typeof fcrRoomSessionParamsSchema>;
export declare const colorSchema: z.ZodObject<{
r: z.ZodNumber;
g: z.ZodNumber;
b: z.ZodNumber;
a: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
r: number;
g: number;
b: number;
a?: number | undefined;
}, {
r: number;
g: number;
b: number;
a?: number | undefined;
}>;
export type ColorSchema = z.infer<typeof colorSchema>;
export declare const fcrPeerSessionParamsSchema: z.ZodObject<{
sessionKey: z.ZodString;
receiverId: z.ZodString;
duration: z.ZodNumber;
payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
}, "strip", z.ZodTypeAny, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
receiverId: string;
}, {
payload: Record<string, unknown>;
sessionKey: string;
duration: number;
receiverId: string;
}>;
export type FcrPeerSessionParamsSchema = z.infer<typeof fcrPeerSessionParamsSchema>;
export declare const fcrGroupCreateConfigSchema: z.ZodObject<{
groupName: z.ZodString;
userList: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
groupName: string;
userList: string[];
}, {
groupName: string;
userList: string[];
}>;
export type FcrGroupCreateConfigSchema = z.infer<typeof fcrGroupCreateConfigSchema>;
export declare const fcrChatRoomSendBaseMessageSchema: z.ZodObject<{
type: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
type: FcrChatRoomMessageType;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}, {
type: FcrChatRoomMessageType;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}>;
export type FcrChatRoomSendBaseMessageSchema = z.infer<typeof fcrChatRoomSendBaseMessageSchema>;
export declare const fcrChatRoomSendTextMessageSchema: z.ZodObject<{
content: z.ZodString;
} & {
type: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
type: FcrChatRoomMessageType;
content: string;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}, {
type: FcrChatRoomMessageType;
content: string;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}>;
export type FcrChatRoomSendTextMessageSchema = z.infer<typeof fcrChatRoomSendTextMessageSchema>;
export declare const fcrChatRoomFileSchema: z.ZodObject<{
fileName: z.ZodString;
fileType: z.ZodString;
filePath: z.ZodOptional<z.ZodString>;
data: z.ZodOptional<z.ZodAny>;
}, "strip", z.ZodTypeAny, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}>;
export type FcrChatRoomFileSchema = z.infer<typeof fcrChatRoomFileSchema>;
export declare const fcrChatRoomSendImageMessageSchema: z.ZodObject<{
file: z.ZodObject<{
fileName: z.ZodString;
fileType: z.ZodString;
filePath: z.ZodOptional<z.ZodString>;
data: z.ZodOptional<z.ZodAny>;
}, "strip", z.ZodTypeAny, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}>;
} & {
type: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
type: FcrChatRoomMessageType;
file: {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
};
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}, {
type: FcrChatRoomMessageType;
file: {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
};
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}>;
export type FcrChatRoomSendImageMessageSchema = z.infer<typeof fcrChatRoomSendImageMessageSchema>;
export declare const messageSchema: z.ZodUnion<[z.ZodObject<{
content: z.ZodString;
} & {
type: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
type: FcrChatRoomMessageType;
content: string;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}, {
type: FcrChatRoomMessageType;
content: string;
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}>, z.ZodObject<{
file: z.ZodObject<{
fileName: z.ZodString;
fileType: z.ZodString;
filePath: z.ZodOptional<z.ZodString>;
data: z.ZodOptional<z.ZodAny>;
}, "strip", z.ZodTypeAny, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}, {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
}>;
} & {
type: z.ZodNativeEnum<typeof FcrChatRoomMessageType>;
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
}, "strip", z.ZodTypeAny, {
type: FcrChatRoomMessageType;
file: {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
};
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}, {
type: FcrChatRoomMessageType;
file: {
fileName: string;
fileType: string;
filePath?: string | undefined;
data?: any;
};
properties?: Record<string, unknown> | undefined;
to?: string[] | undefined;
}>]>;
export type MessageSchema = z.infer<typeof messageSchema>;
export declare const progressSchema: z.ZodFunction<z.ZodTuple<[z.ZodNumber], z.ZodUnknown>, z.ZodVoid>;
export declare const agoraRtcEncryptionConfig: z.ZodObject<{
encryptionKey: z.ZodString;
encryptionMode: z.ZodNativeEnum<typeof AgoraRtcEncryptionMode>;
}, "strip", z.ZodTypeAny, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}>;
export type AgoraRtcEncryptionConfig = z.infer<typeof agoraRtcEncryptionConfig>;
export declare const AgoraRtcDimensions: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
export type AgoraRtcDimensions = z.infer<typeof AgoraRtcDimensions>;
export declare const agoraRtcVideoEncoderConfigurationSchema: z.ZodObject<{
dimensions: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
frameRate: z.ZodNumber;
bitrate: z.ZodNumber;
isMirror: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}>;
export type FcrVideoEncoderConfigurationSchema = z.infer<typeof agoraRtcVideoEncoderConfigurationSchema>;
export declare const fcrStreamJoinConfig: z.ZodObject<{
videoEncoderConfig: z.ZodOptional<z.ZodObject<{
dimensions: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
frameRate: z.ZodNumber;
bitrate: z.ZodNumber;
isMirror: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}>>;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
streamName: z.ZodOptional<z.ZodString>;
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
videoSourceType: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
audioSourceType: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
audioSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
videoSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
}, "strip", z.ZodTypeAny, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}>;
export type FcrStreamJoinConfig = z.infer<typeof fcrStreamJoinConfig>;
export declare const fcrRoomJoinOptionsSchema: z.ZodObject<{
userName: z.ZodString;
userRole: z.ZodNativeEnum<typeof FcrUserRole>;
userProperties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
roomToken: z.ZodString;
streamLatency: z.ZodNativeEnum<typeof AgoraRtcLatencyLevelType>;
streamEncryptionConfig: z.ZodOptional<z.ZodObject<{
encryptionKey: z.ZodString;
encryptionMode: z.ZodNativeEnum<typeof AgoraRtcEncryptionMode>;
}, "strip", z.ZodTypeAny, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}>>;
createStreamConfigs: z.ZodArray<z.ZodObject<{
videoEncoderConfig: z.ZodOptional<z.ZodObject<{
dimensions: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
frameRate: z.ZodNumber;
bitrate: z.ZodNumber;
isMirror: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}>>;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
streamName: z.ZodOptional<z.ZodString>;
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
videoSourceType: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
audioSourceType: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
audioSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
videoSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
}, "strip", z.ZodTypeAny, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}>, "many">;
password: z.ZodOptional<z.ZodString>;
platform: z.ZodOptional<z.ZodNumber>;
avatar: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
userName: string;
userRole: FcrUserRole;
roomToken: string;
streamLatency: AgoraRtcLatencyLevelType;
createStreamConfigs: {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}[];
password?: string | undefined;
userProperties?: Record<string, unknown> | undefined;
streamEncryptionConfig?: {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
} | undefined;
platform?: number | undefined;
avatar?: string | undefined;
}, {
userName: string;
userRole: FcrUserRole;
roomToken: string;
streamLatency: AgoraRtcLatencyLevelType;
createStreamConfigs: {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}[];
password?: string | undefined;
userProperties?: Record<string, unknown> | undefined;
streamEncryptionConfig?: {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
} | undefined;
platform?: number | undefined;
avatar?: string | undefined;
}>;
export type FcrRoomJoinOptionsSchema = z.infer<typeof fcrRoomJoinOptionsSchema>;
export declare const fcrRenderConfigSchema: z.ZodObject<{
renderMode: z.ZodNativeEnum<typeof AgoraRtcRenderMode>;
isMirror: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
isMirror: boolean;
renderMode: AgoraRtcRenderMode;
}, {
isMirror: boolean;
renderMode: AgoraRtcRenderMode;
}>;
export type FcrRenderConfigSchema = z.infer<typeof fcrRenderConfigSchema>;
export declare const fcrGroupUpdateOptionsSchema: z.ZodObject<{
groupId: z.ZodString;
groupName: z.ZodString;
}, "strip", z.ZodTypeAny, {
groupName: string;
groupId: string;
}, {
groupName: string;
groupId: string;
}>;
export type FcrGroupUpdateOptionsSchema = z.infer<typeof fcrGroupUpdateOptionsSchema>;
export declare const fcrRoomJoinOptionsWithTicketSchema: z.ZodObject<{
ticket: z.ZodOptional<z.ZodString>;
} & {
userName: z.ZodString;
userRole: z.ZodNativeEnum<typeof FcrUserRole>;
userProperties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
roomToken: z.ZodString;
streamLatency: z.ZodNativeEnum<typeof AgoraRtcLatencyLevelType>;
streamEncryptionConfig: z.ZodOptional<z.ZodObject<{
encryptionKey: z.ZodString;
encryptionMode: z.ZodNativeEnum<typeof AgoraRtcEncryptionMode>;
}, "strip", z.ZodTypeAny, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}, {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
}>>;
createStreamConfigs: z.ZodArray<z.ZodObject<{
videoEncoderConfig: z.ZodOptional<z.ZodObject<{
dimensions: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
frameRate: z.ZodNumber;
bitrate: z.ZodNumber;
isMirror: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}, {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
}>>;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
streamName: z.ZodOptional<z.ZodString>;
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
videoSourceType: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
audioSourceType: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
audioSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
videoSourceState: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRtcMediaSourceState>>;
}, "strip", z.ZodTypeAny, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}, {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}>, "many">;
password: z.ZodOptional<z.ZodString>;
platform: z.ZodOptional<z.ZodNumber>;
avatar: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
userName: string;
userRole: FcrUserRole;
roomToken: string;
streamLatency: AgoraRtcLatencyLevelType;
createStreamConfigs: {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}[];
password?: string | undefined;
userProperties?: Record<string, unknown> | undefined;
streamEncryptionConfig?: {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
} | undefined;
platform?: number | undefined;
avatar?: string | undefined;
ticket?: string | undefined;
}, {
userName: string;
userRole: FcrUserRole;
roomToken: string;
streamLatency: AgoraRtcLatencyLevelType;
createStreamConfigs: {
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
streamName?: string | undefined;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
videoEncoderConfig?: {
dimensions: {
width: number;
height: number;
};
frameRate: number;
bitrate: number;
isMirror: boolean;
} | undefined;
audioSourceState?: AgoraRtcMediaSourceState | undefined;
videoSourceState?: AgoraRtcMediaSourceState | undefined;
}[];
password?: string | undefined;
userProperties?: Record<string, unknown> | undefined;
streamEncryptionConfig?: {
encryptionKey: string;
encryptionMode: AgoraRtcEncryptionMode;
} | undefined;
platform?: number | undefined;
avatar?: string | undefined;
ticket?: string | undefined;
}>;
export type FcrRoomJoinOptionsWithTicketSchema = z.infer<typeof fcrRoomJoinOptionsWithTicketSchema>;
export declare const fcrMediaStreamCreateConfigSchema: z.ZodObject<{
streamName: z.ZodString;
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
videoSourceType: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
audioSourceType: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
ownerId: z.ZodString;
videoSourceId: z.ZodString;
audioSourceId: z.ZodString;
generateToken: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
streamName: string;
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
ownerId: string;
videoSourceId: string;
audioSourceId: string;
generateToken?: boolean | undefined;
}, {
streamName: string;
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
ownerId: string;
videoSourceId: string;
audioSourceId: string;
generateToken?: boolean | undefined;
}>;
export type FcrMediaStreamCreateConfigSchema = z.infer<typeof fcrMediaStreamCreateConfigSchema>;
export declare const fcrStreamBindConfigSchema: z.ZodObject<{
streamId: z.ZodString;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
streamId: string;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
}, {
streamId: string;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
}>;
export type FcrStreamBindConfigSchema = z.infer<typeof fcrStreamBindConfigSchema>;
export declare const fcrScreenStreamCreateConfigSchema: z.ZodObject<{
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
audioDeviceName: z.ZodOptional<z.ZodString>;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
streamType: AgoraRteMediaStreamType;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
audioDeviceName?: string | undefined;
}, {
streamType: AgoraRteMediaStreamType;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
audioDeviceName?: string | undefined;
}>;
export declare const fcrScreenStreamCreateConfigSize: z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>;
export type FcrScreenStreamCreateConfigSchema = z.infer<typeof fcrScreenStreamCreateConfigSchema>;
export declare const fcrSizeSchema: z.ZodOptional<z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
}, {
width: number;
height: number;
}>>;
export type fcrSizeSchema = z.infer<typeof fcrSizeSchema>;
export declare const fcrGroupCreateConfigArraySchema: z.ZodArray<z.ZodObject<{
groupName: z.ZodString;
userList: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
groupName: string;
userList: string[];
}, {
groupName: string;
userList: string[];
}>, "many">;
export type FcrGroupCreateConfigArraySchema = z.infer<typeof fcrGroupCreateConfigArraySchema>;
export declare const fcrGroupUpdateOptionsArraySchema: z.ZodArray<z.ZodObject<{
groupId: z.ZodString;
groupName: z.ZodString;
}, "strip", z.ZodTypeAny, {
groupName: string;
groupId: string;
}, {
groupName: string;
groupId: string;
}>, "many">;
export type FcrGroupUpdateOptionsArraySchema = z.infer<typeof fcrGroupUpdateOptionsArraySchema>;
export declare const fcrLocalStreamCreateArrayConfigSchema: z.ZodArray<z.ZodObject<{
streamName: z.ZodString;
streamType: z.ZodNativeEnum<typeof AgoraRteMediaStreamType>;
videoSourceType: z.ZodNativeEnum<typeof AgoraRteVideoSourceType>;
audioSourceType: z.ZodNativeEnum<typeof AgoraRtcAudioSourceType>;
ownerId: z.ZodString;
videoSourceId: z.ZodString;
audioSourceId: z.ZodString;
generateToken: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
streamName: string;
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
ownerId: string;
videoSourceId: string;
audioSourceId: string;
generateToken?: boolean | undefined;
}, {
streamName: string;
streamType: AgoraRteMediaStreamType;
videoSourceType: AgoraRteVideoSourceType;
audioSourceType: AgoraRtcAudioSourceType;
ownerId: string;
videoSourceId: string;
audioSourceId: string;
generateToken?: boolean | undefined;
}>, "many">;
export type FcrLocalStreamCreateArrayConfigSchema = z.infer<typeof fcrLocalStreamCreateArrayConfigSchema>;
export declare const fcrInterpreterUsersParamsArraySchema: z.ZodArray<z.ZodObject<{
userId: z.ZodString;
sourceLanguage: z.ZodNativeEnum<typeof FcrLanguage>;
targetLanguage: z.ZodNativeEnum<typeof FcrLanguage>;
}, "strip", z.ZodTypeAny, {
userId: string;
sourceLanguage: FcrLanguage;
targetLanguage: FcrLanguage;
}, {
userId: string;
sourceLanguage: FcrLanguage;
targetLanguage: FcrLanguage;
}>, "many">;
export type FcrInterpreterUsersParamsArraySchema = z.infer<typeof fcrInterpreterUsersParamsArraySchema>;
export declare const fcrStreamBindConfigArrySchema: z.ZodArray<z.ZodObject<{
streamId: z.ZodString;
videoSourceId: z.ZodOptional<z.ZodString>;
audioSourceId: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
streamId: string;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
}, {
streamId: string;
videoSourceId?: string | undefined;
audioSourceId?: string | undefined;
}>, "many">;
export type FcrStreamBindConfigArrySchema = z.infer<typeof fcrStreamBindConfigArrySchema>;
export declare const fcrUpdateStreamPrivilegeScopeSchema: z.ZodObject<{
videoSourceType: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRteStreamPrivilegeVideoSourceType>>;
audioSourceType: z.ZodOptional<z.ZodNativeEnum<typeof AgoraRteStreamPrivilegeAudioSourceType>>;
targetRoleType: z.ZodArray<z.ZodNativeEnum<typeof FcrUserRole>, "many">;
targetRoleTypeIsInclude: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
targetRoleType: FcrUserRole[];
targetRoleTypeIsInclude: boolean;
videoSourceType?: AgoraRteStreamPrivilegeVideoSourceType | undefined;
audioSourceType?: AgoraRteStreamPrivilegeAudioSourceType | undefined;
}, {
targetRoleType: FcrUserRole[];
targetRoleTypeIsInclude: boolean;
videoSourceType?: AgoraRteStreamPrivilegeVideoSourceType | undefined;
audioSourceType?: AgoraRteStreamPrivilegeAudioSourceType | undefined;
}>;
export type FcrUpdateStreamPrivilegeScopeSchema = z.infer<typeof fcrUpdateStreamPrivilegeScopeSchema>;
export declare const fcrUpdateStreamCustomSchema: z.ZodType<unknown, z.ZodTypeDef, unknown>;
export type FcrUpdateStreamProcessSchema = z.infer<typeof fcrUpdateStreamCustomSchema>;
export declare const fcrMobileDeviceIdOrNameSchema: z.ZodOptional<z.ZodString>;
export type fcrMobileDeviceIdOrNameSchema = z.infer<typeof fcrMobileDeviceIdOrNameSchema>;