Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update type definition #3125

Merged
merged 5 commits into from
Jan 11, 2023
Merged

Update type definition #3125

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3f0caa9
Update type definition
jerry4718 Dec 14, 2022
21289f3
Update type definition
jerry4718 Jan 4, 2023
16c0558
Update type definition
jerry4718 Jan 4, 2023
6532650
Update type definition
jerry4718 Jan 5, 2023
17424fe
Update type definition
jerry4718 Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 149 additions & 16 deletions npm/janus.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,78 @@
declare global {
const jQuery: any
}

declare namespace JanusJS {
interface Dependencies {
adapter: any;
WebSocket: (server: string, protocol: string) => WebSocket;
isArray: (array: any) => array is Array<any>;
extension: () => boolean;
httpAPICall: (url: string, options: any) => void;
extension: ChromeExtension;
httpAPICall: (url: string, options: HttpApiCallOption) => void;
}

interface DefaultDependencies extends Dependencies {
fetch: typeof fetch;
Promise: PromiseConstructorLike;
}

interface OldDependencies extends Dependencies {
jQuery: typeof jQuery;
}

interface DependenciesResult {
adapter: any;
newWebSocket: (server: string, protocol: string) => WebSocket;
isArray: (array: any) => array is Array<any>;
extension: () => boolean;
httpAPICall: (url: string, options: any) => void;
extension: ChromeExtension;
httpAPICall: (url: string, options: HttpApiCallOption) => void;
}

type ChromeExtension = {
cache?: { [key in string]: GetScreenCallback },
extensionId: string;
isInstalled: () => boolean;
getScreen: (callback: GetScreenCallback) => void;
init: () => void;
}

type GetScreenCallback = (error?, sourceId?) => void

type HttpApiCallOption = {
async: boolean,
verb: string,
body: JanusRequest,
timeout: number,
withCredentials: boolean,
success: (result: unknown) => void,
error: (error: string, reason?: unknown) => void,
}

type JanusRequest = {
plugin?: string,
token?: string,
apisecret?: string,
session_id?: number,
handle_id?: number,
opaque_id?: number,
jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
loop_index?: number,
janus: string,
transaction: string,
body?: any | string
atoppi marked this conversation as resolved.
Show resolved Hide resolved
jsep?: JSEP
}

enum DebugLevel {
Trace = 'trace',
vDebug = 'vdebug',
Debug = 'debug',
Log = 'log',
Warning = 'warn',
Error = 'error'
Error = 'error',
}

interface JSEP {
ee2e?: boolean;
e2ee?: boolean;
sdp?: string;
type?: string;
rid_order?: "hml" | "lmh";
Expand All @@ -49,6 +97,10 @@ declare namespace JanusJS {
success?: Function;
error?: (error: any) => void;
destroyed?: Function;
iceTransportPolicy?: RTCIceTransportPolicy;
bundlePolicy?: RTCBundlePolicy;
keepAlivePeriod?: number;
longPollTimeout?: number;
}

interface ReconnectOptions {
Expand Down Expand Up @@ -110,6 +162,8 @@ declare namespace JanusJS {
interface PluginOptions extends PluginCallbacks {
plugin: string;
opaqueId?: string;
token?: string;
loopIndex?: number;
}

interface OfferParams {
Expand Down Expand Up @@ -158,10 +212,10 @@ declare namespace JanusJS {
tsnow: string | null;
value: string | null;
};
dataChannel: Array<RTCDataChannel>;
dataChannel: { [key in string]: RTCDataChannel };
dataChannelOptions: RTCDataChannelInit;

dtmfSender: string | null;
dtmfSender: RTCDTMFSender
iceDone: boolean;
mediaConstraints: any;
mySdp: {
Expand All @@ -187,12 +241,84 @@ declare namespace JanusJS {
value: number;
timer: number;
};

jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
sdpSent: boolean,
insertableStreams?: any,
candidates: RTCIceCandidateInit[],
}

type PluginCreateAnswerParam = {
jsep: JSEP;
media: { audioSend: any, videoSend: any };
success?: (data: JSEP) => void;
error?: (error: string) => void;
}

type PluginHandleRemoteJsepParam = {
jsep: JSEP;
success?: (data: JSEP) => void;
error?: (error: string) => void;
}

type PluginReplaceTracksParam = {
tracks: TrackOption[];
success?: (data: unknown) => void;
error?: (error: string) => void;
}

type TrackOption = {
add: boolean;
replace: boolean;
remove: boolean;
type: 'video' | 'screen' | 'audio' | 'data';
mid: string;
capture: MediaStreamTrack;
jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
recv: boolean;
group: 'default' | string;
gumGroup: TrackOption['group'];
simulcast: unknown;
jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
svc: string;
simulcastMaxBitrates: unknown;
jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
sendEncodings: unknown;
jerry4718 marked this conversation as resolved.
Show resolved Hide resolved
framerate: number;
bitrate: number;
dontStop: boolean;
transforms: {
sender: ReadableWritablePair;
atoppi marked this conversation as resolved.
Show resolved Hide resolved
receiver: ReadableWritablePair;
};
}

type PluginDtmfParam = {
dtmf: Dtmf;
success?: (data: unknown) => void;
error?: (error: string) => void;
}

type Dtmf = {
tones: string;
duration: number;
gap: number;
}

type PluginDataParam = {
success?: (data: unknown) => void;
error?: (error: string) => void;
}

type TrackDesc = {
mid?: string
type?: string
id?: string
label?: string
}

interface DetachOptions {
success?: () => void;
error?: (error: string) => void;
noRequest?: boolean;
}

interface PluginHandle {
plugin: string;
id: string;
Expand All @@ -201,28 +327,35 @@ declare namespace JanusJS {
webrtcStuff: WebRTCInfo;
getId(): string;
getPlugin(): string;
send(message: PluginMessage): void;
createOffer(params: OfferParams): void;
createAnswer(params: any): void;
handleRemoteJsep(params: { jsep: JSEP }): void;
dtmf(params: any): void;
data(params: any): void;
getVolume(mid: string, callback: (result: number) => void): void;
getRemoteVolume(mid: string, callback: (result: number) => void): void;
getLocalVolume(mid: string, callback: (result: number) => void): void;
isAudioMuted(): boolean;
muteAudio(): void;
unmuteAudio(): void;
isVideoMuted(): boolean;
muteVideo(): void;
unmuteVideo(): void;
getBitrate(): string;
setMaxBitrate(bitrate: number): void;
send(message: PluginMessage): void;
data(params: PluginDataParam): void;
dtmf(params: PluginDtmfParam): void;
createOffer(params: OfferParams): void;
createAnswer(params: PluginCreateAnswerParam): void;
handleRemoteJsep(params: PluginHandleRemoteJsepParam): void;
replaceTracks(params: PluginReplaceTracksParam): void;
getLocalTracks(): TrackDesc[];
getRemoteTracks(): TrackDesc[];
hangup(sendRequest?: boolean): void;
detach(params?: DetachOptions): void;
}

class Janus {
static webRTCAdapter: any;
static safariVp8: boolean;
static useDefaultDependencies(deps: Partial<Dependencies>): DependenciesResult;
static useOldDependencies(deps: Partial<Dependencies>): DependenciesResult;
static useDefaultDependencies(deps?: Partial<DefaultDependencies>): DependenciesResult;
static useOldDependencies(deps?: Partial<OldDependencies>): DependenciesResult;
static init(options: InitOptions): void;
static isWebrtcSupported(): boolean;
static debug(...args: any[]): void;
Expand Down