Class: AWS.ChimeSDKMediaPipelines
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ChimeSDKMediaPipelines
- Identifier:
- chimesdkmediapipelines
- API Version:
- 2021-07-15
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines.
Sending a Request Using ChimeSDKMediaPipelines
var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines();
chimesdkmediapipelines.createMediaCapturePipeline(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ChimeSDKMediaPipelines object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines({apiVersion: '2021-07-15'});
You can also set the API version globally in AWS.config.apiVersions
using
the chimesdkmediapipelines service identifier:
AWS.config.apiVersions = {
chimesdkmediapipelines: '2021-07-15',
// other service API versions
};
var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines();
Constructor Summary collapse
-
new AWS.ChimeSDKMediaPipelines(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Creates a media capture pipeline.
.
-
deleteMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Deletes the media capture pipeline.
.
-
getMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Gets an existing media capture pipeline.
.
-
listMediaCapturePipelines(params = {}, callback) ⇒ AWS.Request
Returns a list of media capture pipelines.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags applied to an Amazon Chime SDK media capture pipeline.
.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.
.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.ChimeSDKMediaPipelines(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
getMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request
Gets an existing media capture pipeline.
listMediaCapturePipelines(params = {}, callback) ⇒ AWS.Request
Returns a list of media capture pipelines.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags applied to an Amazon Chime SDK media capture pipeline.