getEncodingCodecparameters
Gets the parameters for a specified codec.
Requires authentication as user
getEncodingCodecparameters
Request
get /Encoding/CodecParameters
Parameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *CodecId | query | Codec Id |
||
| *ParameterContext | query | Parameter Context |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | EditObjectContainer | Operation successful. Returning a EditObjectContainer 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
EditObjectContainer
| Name | Type | Notes |
|---|---|---|
| Object | object | |
| DefaultObject | object | |
| TypeName | string | |
| EditorRoot | EditorRoot[] |
EditorRoot
| Name | Type | Notes |
|---|---|---|
| PropertyConditions | PropertyCondition[] | |
| PostbackActions | PostbackAction[] | |
| TitleButton | EditorButtonItem[] | |
| EditorItems | EditorBase[] | |
| EditorType | EditorTypes | |
| Name | string | |
| Id | string | |
| AllowEmpty | boolean | |
| IsReadOnly | boolean | |
| IsAdvanced | boolean | |
| DisplayName | string | |
| Description | string | |
| FeatureRequiresPremiere | boolean | |
| ParentId | string |
PropertyCondition
| Name | Type | Notes |
|---|---|---|
| AffectedPropertyId | string | |
| ConditionType | PropertyConditionType | |
| TargetPropertyId | string | The target property name or path. |
| SimpleCondition | SimpleCondition | Conditions on the source value. |
| ValueCondition | ValueCondition | Conditions for comparing with a target value. |
| Value | object | The value. |
PropertyConditionType
Enum Values
- Visible
- Enabled
SimpleCondition
Enum Values
- IsTrue
- IsFalse
- IsNull
- IsNotNullOrEmpty
ValueCondition
Enum Values
- IsEqual
- IsNotEqual
- IsGreater
- IsGreaterOrEqual
- IsLess
- IsLessOrEqual
PostbackAction
| Name | Type | Notes |
|---|---|---|
| TargetEditorId | string | |
| PostbackCommandId | string | |
| CommandParameterPropertyId | string |
EditorButtonItem
| Name | Type | Notes |
|---|---|---|
| EditorType | EditorTypes | |
| Name | string | |
| Id | string | |
| AllowEmpty | boolean | |
| IsReadOnly | boolean | |
| IsAdvanced | boolean | |
| DisplayName | string | |
| Description | string | |
| FeatureRequiresPremiere | boolean | |
| ParentId | string |
EditorTypes
Enum Values
- Group
- Text
- Numeric
- Boolean
- SelectSingle
- SelectMultiple
- Date
- FilePath
- FolderPath
- StatusItem
- ProgressItem
- ButtonItem
- ButtonGroup
- CaptionItem
- LabelItem
- ItemList
- RadioGroup
- DxDataGrid
- DxPivotGrid
- SpacerItem
EditorBase
| Name | Type | Notes |
|---|---|---|
| EditorType | EditorTypes | |
| Name | string | |
| Id | string | |
| AllowEmpty | boolean | |
| IsReadOnly | boolean | |
| IsAdvanced | boolean | |
| DisplayName | string | |
| Description | string | |
| FeatureRequiresPremiere | boolean | |
| ParentId | string |