getEncodingCodecinformationVideo
Gets details about available video encoders and decoders
Requires authentication as administrator
getEncodingCodecinformationVideo
Request
get /Encoding/CodecInformation/Video
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | VideoCodecBase [] | Operation successful. Returning a VideoCodecBase[] object. |
|
| 400 | Bad Request. Server cannot process request. |
||
| 401 | Unauthorized. Client needs to authenticate. |
||
| 403 | Forbidden. No permission for the reqested operation. |
||
| 404 | Resource not found or unavailable. |
||
| 500 | Server error. |
Definitions
VideoCodecBase
| Name | Type | Notes |
|---|---|---|
| CodecDeviceInfo | ICodecDeviceInfo | |
| CodecKind | CodecKinds | Enum defining the kind of media a codec is processing. |
| MediaTypeName | string | |
| VideoMediaType | VideoMediaTypes | Enum listing video media types. The enum member names are matching exactly those that are used by ffmpeg. Exception: Items that are starting with a number are prefixed with an underscore here. |
| MinWidth | integer (int32) | |
| MaxWidth | integer (int32) | |
| MinHeight | integer (int32) | |
| MaxHeight | integer (int32) | |
| WidthAlignment | integer (int32) | |
| HeightAlignment | integer (int32) | |
| MaxBitRate | BitRate | A type for handling bit rates. The purpose of this type is to avoid manual calculations and conversions in code, unified handling and conversion as well as presentation through its various To***String methods.
|
| SupportedColorFormats | ColorFormats[] | |
| SupportedColorFormatStrings | array | |
| Id | string | |
| Direction | CodecDirections | Enum for indicating the processing direction of a codec. |
| Name | string | |
| Description | string | |
| FrameworkCodec | string | |
| IsHardwareCodec | boolean | |
| SecondaryFramework | SecondaryFrameworks | Enum defining secondary frameworks for encoding and decoding. While most of these are hardware acceleration frameworks, this is not a necessity (e.g. Android MediaCodec offers software codecs as well). |
| SecondaryFrameworkCodec | string | |
| MaxInstanceCount | integer (int32) | |
| IsEnabledByDefault | boolean | |
| DefaultPriority | integer (int32) |
ICodecDeviceInfo
| Name | Type | Notes |
|---|---|---|
| Capabilities | ICodecDeviceCapabilities | |
| Adapter | integer (int32) | |
| Name | string | |
| Desription | string | |
| Driver | string | |
| DriverVersion | Version | |
| ApiVersion | Version | |
| VendorId | integer (int32) | |
| DeviceId | integer (int32) | |
| DeviceIdentifier | string | |
| HardwareContextFramework | SecondaryFrameworks | Enum defining secondary frameworks for encoding and decoding. While most of these are hardware acceleration frameworks, this is not a necessity (e.g. Android MediaCodec offers software codecs as well). |
| DevPath | string | |
| DrmNode | string | |
| VendorName | string | |
| DeviceName | string |
ICodecDeviceCapabilities
| Name | Type | Notes |
|---|---|---|
| SupportsHwUpload | boolean | |
| SupportsHwDownload | boolean | |
| SupportsStandaloneDeviceInit | boolean | |
| Supports10BitProcessing | boolean | |
| SupportsNativeToneMapping | boolean |
Version
| Name | Type | Notes |
|---|---|---|
| Major | integer (int32) | |
| Minor | integer (int32) | |
| Build | integer (int32) | |
| Revision | integer (int32) | |
| MajorRevision | integer (int32) | |
| MinorRevision | integer (int32) |
SecondaryFrameworks
Enum Values
- Unknown
- None
- AmdAmf
- MediaCodec
- NvEncDec
- OpenMax
- QuickSync
- VaApi
- V4L2
- DxVa
- D3d11va
- VideoToolbox
- Mmal
- Vulkan
- D3d12va
- OhCodec
- RkMpp
- Drm
- OpenCL
CodecKinds
see also Emby.Media.Model.Enums.CodecKinds
Enum Values
- Audio
- Video
- SubTitles
VideoMediaTypes
Enum Values
- Unknown
- copy
- flv1
- h263
- h263p
- h264
- hevc
- mjpeg
- mpeg1video
- mpeg2video
- mpeg4
- msvideo1
- theora
- vc1image
- vc1
- vp8
- vp9
- wmv1
- wmv2
- wmv3
- _012v
- _4xm
- _8bps
- a64_multi
- a64_multi5
- aasc
- aic
- alias_pix
- amv
- anm
- ansi
- apng
- asv1
- asv2
- aura
- aura2
- av1
- avrn
- avrp
- avs
- avui
- ayuv
- bethsoftvid
- bfi
- binkvideo
- bintext
- bitpacked
- bmp
- bmv_video
- brender_pix
- c93
- cavs
- cdgraphics
- cdxl
- cfhd
- cinepak
- clearvideo
- cljr
- cllc
- cmv
- cpia
- cscd
- cyuv
- daala
- dds
- dfa
- dirac
- dnxhd
- dpx
- dsicinvideo
- dvvideo
- dxa
- dxtory
- dxv
- escape124
- escape130
- exr
- ffv1
- ffvhuff
- fic
- fits
- flashsv
- flashsv2
- flic
- fmvc
- fraps
- frwu
- g2m
- gdv
- gif
- h261
- h263i
- hap
- hnm4video
- hq_hqa
- hqx
- huffyuv
- idcin
- idf
- iff_ilbm
- indeo2
- indeo3
- indeo4
- indeo5
- interplayvideo
- jpeg2000
- jpegls
- jv
- kgv1
- kmvc
- lagarith
- ljpeg
- loco
- m101
- mad
- magicyuv
- mdec
- mimic
- mjpegb
- mmvideo
- motionpixels
- msa1
- mscc
- msmpeg4v1
- msmpeg4v2
- msmpeg4v3
- msrle
- mss1
- mss2
- mszh
- mts2
- mvc1
- mvc2
- mxpeg
- nuv
- paf_video
- pam
- pbm
- pcx
- pgm
- pgmyuv
- pictor
- pixlet
- png
- ppm
- prores
- psd
- ptx
- qdraw
- qpeg
- qtrle
- r10k
- r210
- rawvideo
- rl2
- roq
- rpza
- rscc
- rv10
- rv20
- rv30
- rv40
- sanm
- scpr
- screenpresso
- sgi
- sgirle
- sheervideo
- smackvideo
- smc
- smvjpeg
- snow
- sp5x
- speedhq
- srgc
- sunrast
- svg
- svq1
- svq3
- targa
- targa_y216
- tdsc
- tgq
- tgv
- thp
- tiertexseqvideo
- tiff
- tmv
- tqi
- truemotion1
- truemotion2
- truemotion2rt
- tscc
- tscc2
- txd
- ulti
- utvideo
- v210
- v210x
- v308
- v408
- v410
- vb
- vble
- vcr1
- vixl
- vmdvideo
- vmnc
- vp3
- vp5
- vp6
- vp6a
- vp6f
- vp7
- webp
- wmv3image
- wnv1
- wrapped_avframe
- ws_vqa
- xan_wc3
- xan_wc4
- xbin
- xbm
- xface
- xpm
- xwd
- y41p
- ylc
- yop
- yuv4
- zerocodec
- zlib
- zmbv
- agm
- apv
- arbc
- argo
- avs2
- avs3
- cdtoons
- cri
- dnxuc
- evc
- gem
- hdr
- hymt
- imm4
- imm5
- ipu
- jpegxl
- jpegxl_anim
- lead
- lscr
- media100
- mobiclip
- msp2
- mv30
- mvdv
- mvha
- mwsc
- notchlc
- pdv
- pfm
- pgx
- phm
- photocd
- prores_raw
- prosumer
- qoi
- rasc
- rtv1
- rv60
- sga
- simbiosis_imx
- vbn
- vmix
- vp4
- vqc
- vvc
- wbmp
- wcmv
BitRate
see also Emby.Media.Model.Types.BitRate
| Name | Type | Notes |
|---|---|---|
| bps | integer (int64) | |
| kbps | number (double) | |
| Mbps | number (double) |
ColorFormats
see also Emby.Media.Model.Enums.ColorFormats
CodecDirections
Enum Values
- Encoder
- Decoder