

# PreferencesDescription
<a name="structures-PreferencesDescription"></a>

Complex type specifying preferences configured on the client. 

**Note:** The configuration that is returned takes into account user preferences. If the preference name starts with `maximum_`, it is considered a limit set by the user. However, user preferences may be overridden by the limitations of the service. For example, if the user sets `maximum_video_tracks` to 4 but the service only supports 3, the returned configuration contains only 3 video tracks.

## Contents
<a name="structures-PreferencesDescription-contente"></a>
+ **canvas\$1height**
  + The height in pixels of the canvas being encoded.
  + Type: Integer
  + Required: Yes
+ **canvas\$1width**
  + The width in pixels of the canvas being encoded.
  + Type: Integer
  + Required: Yes
+ **composition\$1gpu\$1index**
  + An index (zero-based) specifying which [GpuDescription](structures-GpuDescription.md) object the client is using for graphics composition and streaming.
  + Type: Integer
  + Required: No
+ **framerate**
  + Requested framerate.
  + Type: [Framerate](structures-Framerate.md) object
  + Required: Yes
+ **height**
  + Requested output resolution height in pixels. Must be less or equal to `canvas_height`.
  + Type: Integer
  + Required: Yes
+ **maximum\$1streaming\$1bandwidth**
  + Maximum bandwidth in kilobits per second that the user allocated for streaming. Default: null (no user preference).
  + Type: Integer
  + Required: No
+ **maximum\$1resolution**
  + Maximum resolution of the highest quality video track. Default: null (no user preference).
  + Type: String
  + Valid Values: `SD` \$1 `HD` \$1 `FULL_HD`
  + Required: No
+ **maximum\$1video\$1tracks**
  + Maximum number of video tracks that the user allocates for multitrack video streaming. Default: null (no user preference).
  + Type: Integer
  + Required: No
+ **vod\$1track\$1audio**
  + Whether an audio track will be created for video on demand, separate from the live stream. Default: `false` (no separate audio track for video on demand).

    **Note:** This parameter is ignored if the stream key provided in the `authentication` field of the request does not start with `live_`.
  + Type: Boolean
  + Required: No
+ **width**
  + Requested output resolution width in pixels. Must be less or equal to `canvas_width`.
  + Type: Integer
  + Required: Yes