headVideosByIdByStreamfilename
Gets a video stream
Requires authentication as user
headVideosByIdByStreamfilename
Request
head /Videos/{Id}/{StreamFileName}
Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| DeviceProfileId | query | Optional. The dlna device profile id to utilize. |
||
| *StreamFileName | path | |||
| *Id | path | Item Id |
||
| DeviceId | query | The device id of the client requesting. Used to stop encoding processes when needed. |
||
| *Container | query | Container |
||
| AudioCodec | query | Optional. Specify a audio codec to encode to, e.g. mp3. If omitted the server will auto-select using the url's extension. Options: aac, mp3, vorbis, wma. |
||
| EnableAutoStreamCopy | query | Whether or not to allow automatic stream copy if requested values match the original source. Defaults to true. |
||
| AudioSampleRate | query | Optional. Specify a specific audio sample rate, e.g. 44100 |
||
| AudioBitRate | query | Optional. Specify an audio bitrate to encode to, e.g. 128000. If omitted this will be left to encoder defaults. |
||
| AudioChannels | query | Optional. Specify a specific number of audio channels to encode to, e.g. 2 |
||
| MaxAudioChannels | query | Optional. Specify a maximum number of audio channels to encode to, e.g. 2 |
||
| Static | query | Optional. If true, the original file will be streamed statically without any encoding. Use either no url extension or the original file extension. true/false |
||
| CopyTimestamps | query | Whether or not to copy timestamps when transcoding with an offset. Defaults to false. |
||
| StartTimeTicks | query | Optional. Specify a starting offset, in ticks. 1ms = 10000 ticks. |
||
| Width | query | Optional. The fixed horizontal resolution of the encoded video. |
||
| Height | query | Optional. The fixed vertical resolution of the encoded video. |
||
| MaxWidth | query | Optional. The maximum horizontal resolution of the encoded video. |
||
| MaxHeight | query | Optional. The maximum vertical resolution of the encoded video. |
||
| VideoBitRate | query | Optional. Specify a video bitrate to encode to, e.g. 500000. If omitted this will be left to encoder defaults. |
||
| SubtitleStreamIndex | query | Optional. The index of the subtitle stream to use. If omitted no subtitles will be used. |
||
| SubtitleMethod | query | Optional. Specify the subtitle delivery method. |
||
| MaxVideoBitDepth | query | Optional. |
||
| VideoCodec | query | Optional. Specify a video codec to encode to, e.g. h264. If omitted the server will auto-select using the url's extension. Options: h264, mpeg4, theora, vpx, wmv. |
||
| AudioStreamIndex | query | Optional. The index of the audio stream to use. If omitted the first audio stream will be used. |
||
| VideoStreamIndex | query | Optional. The index of the video stream to use. If omitted the first video stream will be used. |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | Operation successful. Response content unknown. |
||
| 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. |