In this article:

URI Parameters

Responses

Examples

Definitions

Get transform
Gets a transform.

GET https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}?api-version={{api-version}}

URI Parameters

Responses

Examples

Get a Transform by name

GET https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/sampleTransform?api-version={{api-version}}

/**
 * Samples for Transforms Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/transforms-get-
     * by-name.json
     */
    /**
     * Sample code: Get a Transform by name.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getATransformByName(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.transforms().getWithResponse("contosoresources", "contosomedia", "sampleTransform",
            com.azure.core.util.Context.NONE);
    }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python transformsgetbyname.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AzureMediaServices(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.transforms.get(
        resource_group_name="contosoresources",
        account_name="contosomedia",
        transform_name="sampleTransform",
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/transforms-get-by-name.json
if __name__ == "__main__":
    main()

const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a Transform.
 *
 * @summary Gets a Transform.
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/transforms-get-by-name.json
 */
async function getATransformByName() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contosoresources";
  const accountName = "contosomedia";
  const transformName = "sampleTransform";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.transforms.get(resourceGroupName, accountName, transformName);
  console.log(result);
}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Encoding/stable/2022-07-01/examples/transforms-get-by-name.json
// this example is just showing the usage of "Transforms_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MediaServicesAccountResource created on azure
// for more information of creating MediaServicesAccountResource, please refer to the document of MediaServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosoresources";
string accountName = "contosomedia";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// get the collection of this MediaTransformResource
MediaTransformCollection collection = mediaServicesAccount.GetMediaTransforms();

// invoke the operation
string transformName = "sampleTransform";
NullableResponse response = await collection.GetIfExistsAsync(transformName);
MediaTransformResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    MediaTransformData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Sample response

Status code: 200

{
  "name": "sampleTransform",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleTransform",
  "type": "Microsoft.Media/mediaservices/transforms",
  "properties": {
    "created": "2022-10-17T23:14:31.6281097Z",
    "description": "A sample Transform using the Standard Encoder with a built in preset.",
    "lastModified": "2022-10-17T23:14:31.6281097Z",
    "outputs": [
      {
        "onError": "StopProcessingJob",
        "relativePriority": "Normal",
        "preset": {
          "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset",
          "presetName": "H264MultipleBitrate1080p"
        }
      }
    ]
  },
  "systemData": {
    "createdBy": "contoso@microsoft.com",
    "createdByType": "User",
    "createdAt": "2022-10-17T23:14:31.6281097Z",
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-10-17T23:14:31.6281097Z"
  }
}

Definitions

AacAudio

Describes Advanced Audio Codec (AAC) audio encoding settings.

AacAudioProfile

The encoding profile to be used when encoding audio with AAC.

Audio

Defines the common properties for all audio codecs.

AudioAnalysisMode

Determines the set of audio analysis operations to be performed. If unspecified, the Standard AudioAnalysisMode would be chosen.

AudioAnalyzerPreset

The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track.

BlurType

BuiltInStandardEncoderPreset

Describes a built-in preset for encoding the input video with the Standard Encoder.

Complexity

Allows you to configure the encoder settings to control the balance between speed and quality. Example: set Complexity as Speed for faster encoding but less compression efficiency.

CopyAudio

A codec flag, which tells the encoder to copy the input audio bitstream.

CopyVideo

A codec flag, which tells the encoder to copy the input video bitstream without re-encoding.

createdByType

The type of identity that created the resource.

DDAudio

Describes Dolby Digital Audio Codec (AC3) audio encoding settings. The current implementation for Dolby Digital Audio support are: Audio channel numbers at 1((mono), 2(stereo), 6(5.1side); Audio sampling frequency rates at: 32K/44.1K/48K Hz; Audio bitrate values as AC3 specification supports: 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 576000, 640000 bps.

Deinterlace

Describes the de-interlacing settings.

DeinterlaceMode

The deinterlacing mode. Defaults to AutoPixelAdaptive.

DeinterlaceParity

The field parity for de-interlacing, defaults to Auto.

EncoderNamedPreset

The built-in preset to be used for encoding videos.

EntropyMode

The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Fade

Describes the properties of a Fade effect applied to the input media.

Filters

Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding.

H264Complexity

Tells the encoder how to choose its encoding settings. The default value is Balanced.

H264Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec.

H264RateControlMode

The video rate control mode

H264Video

Describes all the properties for encoding a video with the H.264 codec.

H264VideoProfile

We currently support Baseline, Main, High, High422, High444. Default is Auto.

H265Complexity

Tells the encoder how to choose its encoding settings. Quality will provide for a higher compression ratio but at a higher cost and longer compute time. Speed will produce a relatively larger file but is faster and more economical. The default value is Balanced.

H265Layer

Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.265 video codec.

H265Video

Describes all the properties for encoding a video with the H.265 codec.

H265VideoProfile

We currently support Main. Default is Auto.

Image

Describes the basic properties for generating thumbnails from the input video

ImageFormat

Describes the properties for an output image file.

IsNonInterleaved (former InterleaveOutput)

Sets the interleave mode of the output to control how audio and video are stored in the container format. When set to true (default), produces audio-only and video-only outputs in separate MP4 files. When set to false, produces combined audio and video in a single interleaved file.

JpgFormat

Describes the settings for producing JPEG thumbnails.

JpgImage

Describes the properties for producing a series of JPEG images from the input video.

JpgLayer

Describes the settings to produce a JPEG image from the input video.

Mp4Format

Describes the properties for an output ISO MP4 file.

MultiBitrateFormat

Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection.

OnErrorType

A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'.

OutputFile

Represents an output file produced.

PngFormat

Describes the settings for producing PNG thumbnails.

PngImage

Describes the properties for producing a series of PNG images from the input video.

PngLayer

Describes the settings to produce a PNG image from the input video.

PresetConfigurations

An object of optional configuration settings for encoder.

Priority

Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal.

Rectangle

Defines the dimensions and position of a rectangular region. When applied to media, the aspect ratio of the source content is always preserved. If the specified dimensions do not match the source aspect ratio, one dimension (height or width) will be automatically adjusted to maintain the original proportions, and some specified values may be ignored.

Rotation

The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto

StandardEncoderPreset

Describes all the settings to be used when encoding the input video with the Standard Encoder.

StretchMode

The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize

systemData

Metadata pertaining to creation and last modification of the resource.

Transform

A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs.

/subscriptions/{subscriptionId}/resource
Groups/{resourceGroupName}/providers/
{resourceProviderNamespace}/{resource
Type}/{resourceName}

TransformOutput

Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output.

Video

Describes the basic properties for encoding the input video.

VideoOverlay

Describes the properties of a video overlay.

RMS never stretches media to fit specified dimensions. Aspect ratio of source content is always preserved. When dimensions conflict with source proportions, automatic adjustments occur. The specific dimension adjusted (height vs width) is determined automatically for optimal results.

VideoSyncMode

The Video Sync Mode