Class DefaultVideoCaptureAndEncodeParameter

[[VideoCaptureAndEncodeParameter]] encapsulates video parameters for capturing and encoding

Implements

VideoCaptureAndEncodeParameter

Index

Constructors

Methods

captureFrameRate captureHeight captureWidth clone encodeBitrates encodeHeights encodeScaleResolutionDownBy encodeWidths equal isSVCEncoding

Constructors

constructor

new DefaultVideoCaptureAndEncodeParameter(
    cameraWidth: number,
    cameraHeight: number,
    cameraFrameRate: number,
    maxEncodeBitrateKbps: number,
    isSimulcast: boolean,
    scaleResolutionDownBy?: number,
    isSVC?: boolean,
): DefaultVideoCaptureAndEncodeParameter
Parameters
- cameraWidth: number
- cameraHeight: number
- cameraFrameRate: number
- maxEncodeBitrateKbps: number
- isSimulcast: boolean
- scaleResolutionDownBy: number = 1
- isSVC: boolean = false
Returns DefaultVideoCaptureAndEncodeParameter
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:7

Methods

captureFrameRate

captureFrameRate(): number
Returns the desired frame rate for camera capture

Returns number
Implementation of VideoCaptureAndEncodeParameter.captureFrameRate
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:65

captureHeight

captureHeight(): number
Returns the desired height for camera capture

Returns number
Implementation of VideoCaptureAndEncodeParameter.captureHeight
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:61

captureWidth

captureWidth(): number
Returns the desired width for camera capture

Returns number
Implementation of VideoCaptureAndEncodeParameter.captureWidth
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:57

clone

clone(): DefaultVideoCaptureAndEncodeParameter
Returns a clone of [[VideoCaptureAndEncodeParameter]]

Returns DefaultVideoCaptureAndEncodeParameter
Implementation of VideoCaptureAndEncodeParameter.clone
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:45

encodeBitrates

encodeBitrates(): number[]
Returns an ascending array of desired bitrates in Kilo-bps for video encoding.

Returns number[]
Implementation of VideoCaptureAndEncodeParameter.encodeBitrates
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:69

encodeHeights

encodeHeights(): number[]
Returns an ascending array of heights for video encoding

Returns number[]
Implementation of VideoCaptureAndEncodeParameter.encodeHeights
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:82

encodeScaleResolutionDownBy

encodeScaleResolutionDownBy(): number[]
Returns number[]
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:74

encodeWidths

encodeWidths(): number[]
Returns an ascending array of widths for video encoding.

Returns number[]
Implementation of VideoCaptureAndEncodeParameter.encodeWidths
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:78

equal

equal(other: DefaultVideoCaptureAndEncodeParameter): boolean
Returns whether two [[VideoCaptureAndEncodeParameter]] are same
Parameters
- other: DefaultVideoCaptureAndEncodeParameter
Returns boolean
Implementation of VideoCaptureAndEncodeParameter.equal
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:17

isSVCEncoding

isSVCEncoding(): boolean
Returns boolean
- Defined in src/videocaptureandencodeparameter/DefaultVideoCaptureAndEncodeParameter.ts:86