ivsrealtime / Client / create_encoder_configuration
create_encoder_configuration#
- ivsrealtime.Client.create_encoder_configuration(**kwargs)#
Creates an EncoderConfiguration object.
See also: AWS API Documentation
Request Syntax
response = client.create_encoder_configuration( name='string', tags={ 'string': 'string' }, video={ 'bitrate': 123, 'framerate': ..., 'height': 123, 'width': 123 } )
- Parameters:
name (string) – Optional name to identify the resource.
tags (dict) –
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.(string) –
(string) –
video (dict) –
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
bitrate (integer) –
Bitrate for generated output, in bps. Default: 2500000.
framerate (float) –
Video frame rate, in fps. Default: 30.
height (integer) –
Video-resolution height. Note that the maximum value is determined by
width
timesheight
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.width (integer) –
Video-resolution width. Note that the maximum value is determined by
width
timesheight
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
- Return type:
dict
- Returns:
Response Syntax
{ 'encoderConfiguration': { 'arn': 'string', 'name': 'string', 'tags': { 'string': 'string' }, 'video': { 'bitrate': 123, 'framerate': ..., 'height': 123, 'width': 123 } } }
Response Structure
(dict) –
encoderConfiguration (dict) –
The EncoderConfiguration that was created.
arn (string) –
ARN of the EncoderConfiguration resource.
name (string) –
Optional name to identify the resource.
tags (dict) –
Tags attached to the resource. Array of maps, each of the form
string:string (key:value)
. See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.(string) –
(string) –
video (dict) –
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps
bitrate (integer) –
Bitrate for generated output, in bps. Default: 2500000.
framerate (float) –
Video frame rate, in fps. Default: 30.
height (integer) –
Video-resolution height. Note that the maximum value is determined by
width
timesheight
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.width (integer) –
Video-resolution width. Note that the maximum value is determined by
width
timesheight
, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.
Exceptions
ivsrealtime.Client.exceptions.ResourceNotFoundException
ivsrealtime.Client.exceptions.ValidationException
ivsrealtime.Client.exceptions.AccessDeniedException
ivsrealtime.Client.exceptions.InternalServerException
ivsrealtime.Client.exceptions.ServiceQuotaExceededException
ivsrealtime.Client.exceptions.ConflictException
ivsrealtime.Client.exceptions.PendingVerification