@webex/web-client-media-engine 3.37.0 → 3.38.0

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
 import { LocalStream, ConnectionState, ConnectionType, media } from '@webex/webrtc-core';
 export { AudioDeviceConstraints, ConnectionState, ConnectionType, LocalCameraStream, LocalDisplayStream, LocalMicrophoneStream, LocalStream, LocalStreamEventNames, LocalSystemAudioStream, MediaStreamTrackKind, PeerConnection, RemoteMediaState, RemoteStream, RemoteStreamEventNames, StreamEventNames, VideoContentHint, VideoDeviceConstraints, Logger as WebRtcCoreLogger, WebrtcCoreError, WebrtcCoreErrorType, createCameraAndMicrophoneStreams, createCameraStream, createDisplayMedia, createDisplayStream, createDisplayStreamWithAudio, createMicrophoneStream, getAudioInputDevices, getAudioOutputDevices, getDevices, getVideoInputDevices, setOnDeviceChangeHandler } from '@webex/webrtc-core';
-import { SsrcStreamId, StreamState, MediaContent, MediaType, NamedMediaGroup, Policy, PolicySpecificInfo, CodecInfo, StreamRequest as StreamRequest$1 } from '@webex/json-multistream';
-export { ActiveSpeakerInfo, CodecInfo, H264Codec, Logger as JMPLogger, MediaContent, MediaFamily, MediaType, NamedMediaGroup, Policy, PolicySpecificInfo, ReceiverSelectedInfo, StreamState, getMediaContent, getMediaFamily, getMediaType } from '@webex/json-multistream';
+import { CodecInfo, AV1Codec, H264Codec, SsrcStreamId, StreamState, MediaContent, MediaType, NamedMediaGroup, Policy, PolicySpecificInfo, StreamRequest as StreamRequest$1 } from '@webex/json-multistream';
+export { AV1Codec, ActiveSpeakerInfo, CodecInfo, H264Codec, Logger as JMPLogger, MediaContent, MediaFamily, MediaType, NamedMediaGroup, Policy, PolicySpecificInfo, ReceiverSelectedInfo, StreamState, getMediaContent, getMediaFamily, getMediaType } from '@webex/json-multistream';
 import { LoggerCallback } from '@webex/rtcstats';
 export { LogData, LoggerCallback as MetricsCallback } from '@webex/rtcstats';
 import TypedEmitter, { EventMap } from 'typed-emitter';
@@ -16,12 +16,27 @@ declare enum MediaCodecMimeType {
     RTX = "video/rtx",
     OPUS = "audio/opus"
 }
-type EncodingParams = {
+type SupportedResolution = '1080p' | '720p' | '540p' | '360p' | '180p' | '90p';
+type BaseVideoEncodingParams = {
     maxPayloadBitsPerSecond?: number;
-    maxFs?: number;
     maxWidth?: number;
     maxHeight?: number;
 };
+type H264EncodingParams = BaseVideoEncodingParams & {
+    maxFs?: number;
+    maxFps?: number;
+    maxMbps?: number;
+};
+type AV1EncodingParams = BaseVideoEncodingParams & {
+    levelIdx?: number;
+    tier?: number;
+    maxPicSize?: number;
+    maxDecodeRate?: number;
+};
+type OpusEncodingParams = {
+    maxPayloadBitsPerSecond?: number;
+};
+type EncodingParams = H264EncodingParams | AV1EncodingParams | OpusEncodingParams;
 declare enum RecommendedOpusBitrates {
     NB = 12000,
     WB = 20000,
@@ -29,8 +44,12 @@ declare enum RecommendedOpusBitrates {
     FB_MONO_MUSIC = 64000,
     FB_STEREO_MUSIC = 128000
 }
+declare function codecToEncodingParams(codecInfo: CodecInfo): AV1Codec | H264Codec | undefined;
 declare function getRecommendedMaxBitrateForFrameSize(requestedMaxFs: number): number;
-type CodecParameters = Record<string, string | undefined>;
+type CodecParameters = Record<string, string | undefined>;
+declare function getRecommendedMaxBitrateForPicSize(requestedMaxPicSize: number): number;
+declare function getFrameSizeForPicSize(maxPicSize: number | undefined): number | undefined;
+declare function isEncodingCodecSupported(): boolean;
 
 declare enum WcmeErrorType {
     CREATE_OFFER_FAILED = "CREATE_OFFER_FAILED",
@@ -46,6 +65,7 @@ declare enum WcmeErrorType {
     SET_SOURCE_STATE_OVERRIDE_FAILED = "SET_SOURCE_STATE_OVERRIDE_FAILED",
     DATA_CHANNEL_SEND_FAILED = "DATA_CHANNEL_SEND_FAILED",
     RENEW_PEER_CONNECTION_FAILED = "RENEW_PEER_CONNECTION_FAILED",
+    INVALID_CODEC_PARAMS = "INVALID_CODEC_PARAMS",
     UNSUPPORTED_CONFIG = "UNSUPPORTED_CONFIG"
 }
 declare class WcmeError {
@@ -117,6 +137,7 @@ declare class EgressSdpMunger {
         rtxEnabled: boolean;
         twccDisabled: boolean;
         forceSoftwareEncoder: boolean;
+        supportedCodecs: MediaCodecMimeType[];
     }): void;
     mungeLocalDescriptionForRemoteServer(mediaDescription: AvMediaDescription, mediaContent: MediaContent, csi: number, mungeOptions?: {
         injectDummyCandidates: boolean;
@@ -166,10 +187,12 @@ declare class SendOnlyTransceiver extends Transceiver {
     negotiationNeeded: TypedEvent<(offerAnswerType: OfferAnswerType) => void>;
     namedMediaGroupsChange: TypedEvent<() => void>;
     private requestedIdEncodingParamsMap;
+    private selectedPayloadType;
     namedMediaGroups?: NamedMediaGroup[];
     private updateSendParametersQueue;
     private sourceStateOverride?;
     sourceStateOverrideChange: TypedEvent<() => void>;
+    private supportedCodecs;
     metadata: {
         lastRequestedUpdateTimestampsMap: Map<number, number>;
     };
@@ -179,6 +202,7 @@ declare class SendOnlyTransceiver extends Transceiver {
         mediaType: MediaType;
         munger: EgressSdpMunger;
         csi: number;
+        supportedCodecs: MediaCodecMimeType[];
     });
     private replaceSenderSource;
     private handleTrackChange;
@@ -194,7 +218,7 @@ declare class SendOnlyTransceiver extends Transceiver {
     get active(): boolean;
     set active(enabled: boolean);
     getStats(): Promise<StatsMap>;
-    updateSendParameters(requestedIdEncodingParamsMap: Map<number, EncodingParams>): Promise<void>;
+    updateSendParameters(requestedIdEncodingParamsMap: Map<number, EncodingParams>, payloadType?: number): Promise<void>;
     private isSimulcastEnabled;
     mungeLocalDescription(mediaDescription: AvMediaDescription): void;
     mungeLocalDescriptionForRemoteServer(mediaDescription: AvMediaDescription, mungeOptions?: {
@@ -309,6 +333,7 @@ type MultistreamConnectionOptions = {
     preferredStartingBitrateKbps: number;
     metricsCallback: LoggerCallback;
     enableInboundAudioLevelMonitoring: boolean;
+    enableAV1SlidesSupport: boolean;
 };
 declare class MultistreamConnection extends EventEmitter<MultistreamConnectionEvents> {
     private id;
@@ -343,6 +368,7 @@ declare class MultistreamConnection extends EventEmitter<MultistreamConnectionEv
     private getVideoEncodingOptions;
     private getCustomSendVideoCodecParams;
     private getCustomReceiveVideoCodecParams;
+    private getSupportedCodecs;
     private createSendTransceiver;
     createSendSlot(mediaType: MediaType, active?: boolean): SendSlot;
     private createJmpSession;
@@ -390,4 +416,4 @@ declare function setLogHandler(logHandler: ILogHandler): void;
 declare const DeviceKind: typeof media.DeviceKind;
 //# sourceMappingURL=index.d.ts.map
 
-export { AudioMetadata, CodecParameters, DeviceKind, MediaCodecMimeType, MultistreamConnection, MultistreamConnectionEventNames, MultistreamConnectionEvents, MultistreamConnectionOptions, ReceiveSlot, ReceiveSlotEvents, ReceiveSlotId, ReceiverEvents, RecommendedOpusBitrates, SendSlot, StatsMap, StreamRequest, TransceiverStatItem, TransceiverStats, VideoMetadata, WcmeError, WcmeErrorType, areReceiveSlotIdsEqual, getLogLevel, getRecommendedMaxBitrateForFrameSize, logErrorAndThrow, setLogHandler, setLogLevel };
+export { AV1EncodingParams, AudioMetadata, BaseVideoEncodingParams, CodecParameters, DeviceKind, EncodingParams, H264EncodingParams, MediaCodecMimeType, MultistreamConnection, MultistreamConnectionEventNames, MultistreamConnectionEvents, MultistreamConnectionOptions, OpusEncodingParams, ReceiveSlot, ReceiveSlotEvents, ReceiveSlotId, ReceiverEvents, RecommendedOpusBitrates, SendSlot, StatsMap, StreamRequest, SupportedResolution, TransceiverStatItem, TransceiverStats, VideoMetadata, WcmeError, WcmeErrorType, areReceiveSlotIdsEqual, codecToEncodingParams, getFrameSizeForPicSize, getLogLevel, getRecommendedMaxBitrateForFrameSize, getRecommendedMaxBitrateForPicSize, isEncodingCodecSupported, logErrorAndThrow, setLogHandler, setLogLevel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/web-client-media-engine",
-  "version": "3.37.0",
+  "version": "3.38.0",
   "description": "Web Client Media Engine is common web code for interacting with the multistream media server.",
   "source": "src/index.ts",
   "main": "dist/cjs/index.js",
@@ -60,9 +60,9 @@
     "@webex/rtcstats": "^1.5.5",
     "@webex/ts-events": "^1.2.1",
     "@webex/ts-sdp": "1.8.2",
-    "@webex/web-capabilities": "^1.7.1",
-    "@webex/web-media-effects": "2.32.1",
-    "@webex/webrtc-core": "2.13.4",
+    "@webex/web-capabilities": "^1.9.0",
+    "@webex/web-media-effects": "2.33.0",
+    "@webex/webrtc-core": "2.13.5",
     "async": "^3.2.4",
     "js-logger": "^1.6.1",
     "typed-emitter": "^2.1.0",