ElasticTranscoderClient Class

Member Function Documentation

ElasticTranscoderClient::ElasticTranscoderClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a ElasticTranscoderClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

ElasticTranscoderClient::ElasticTranscoderClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads ElasticTranscoderClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelJobResponse *ElasticTranscoderClient::cancelJob(const CancelJobRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an CancelJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The CancelJob operation cancels an unfinished

job> <note>

You can only cancel a job that has a status of <code>Submitted</code>. To prevent a pipeline from starting to process a job while you're getting the job identifier, use <a>UpdatePipelineStatus</a> to temporarily pause the

[slot] CreateJobResponse *ElasticTranscoderClient::createJob(const CreateJobRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an CreateJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is

created>

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS

[slot] CreatePipelineResponse *ElasticTranscoderClient::createPipeline(const CreatePipelineRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an CreatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The CreatePipeline operation creates a pipeline with settings that you

[slot] CreatePresetResponse *ElasticTranscoderClient::createPreset(const CreatePresetRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an CreatePresetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The CreatePreset operation creates a preset with settings that you

specify> <b>

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (<code>ValidationException</code>) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder

produces> </b>

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication <i>Recommendation ITU-T H.264: Advanced video coding for generic audiovisual

[slot] DeletePipelineResponse *ElasticTranscoderClient::deletePipeline(const DeletePipelineRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an DeletePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The DeletePipeline operation removes a

pipeline>

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, <code>DeletePipeline</code> returns an error.

[slot] DeletePresetResponse *ElasticTranscoderClient::deletePreset(const DeletePresetRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an DeletePresetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The DeletePreset operation removes a preset that you've added in an AWS

region> <note>

You can't delete the default presets that are included with Elastic

[slot] ListJobsByPipelineResponse *ElasticTranscoderClient::listJobsByPipeline(const ListJobsByPipelineRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ListJobsByPipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ListJobsByPipeline operation gets a list of the jobs currently in a

pipeline>

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search

[slot] ListJobsByStatusResponse *ElasticTranscoderClient::listJobsByStatus(const ListJobsByStatusRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ListJobsByStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search

[slot] ListPipelinesResponse *ElasticTranscoderClient::listPipelines(const ListPipelinesRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ListPipelinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ListPipelines operation gets a list of the pipelines associated with the current AWS

[slot] ListPresetsResponse *ElasticTranscoderClient::listPresets(const ListPresetsRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ListPresetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS

[slot] ReadJobResponse *ElasticTranscoderClient::readJob(const ReadJobRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ReadJobResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ReadJob operation returns detailed information about a

[slot] ReadPipelineResponse *ElasticTranscoderClient::readPipeline(const ReadPipelineRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ReadPipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ReadPipeline operation gets detailed information about a

[slot] ReadPresetResponse *ElasticTranscoderClient::readPreset(const ReadPresetRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an ReadPresetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The ReadPreset operation gets detailed information about a

[slot] TestRoleResponse *ElasticTranscoderClient::testRole(const TestRoleRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an TestRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The TestRole operation tests the IAM role used to create the

pipeline>

The <code>TestRole</code> action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you

[slot] UpdatePipelineResponse *ElasticTranscoderClient::updatePipeline(const UpdatePipelineRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an UpdatePipelineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Use the <code>UpdatePipeline</code> operation to update settings for a

pipeline> <b>

When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

[slot] UpdatePipelineNotificationsResponse *ElasticTranscoderClient::updatePipelineNotifications(const UpdatePipelineNotificationsRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an UpdatePipelineNotificationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a

pipeline>

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the

[slot] UpdatePipelineStatusResponse *ElasticTranscoderClient::updatePipelineStatus(const UpdatePipelineStatusRequest &request)

Sends request to the ElasticTranscoderClient service, and returns a pointer to an UpdatePipelineStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of

jobs>

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a <a>CancelJob</a> request.