Mux.Csharp.Sdk.Api.PlaybackRestrictionsApi

All URIs are relative to https://api.mux.com

Method	HTTP request	Description
CreatePlaybackRestriction	POST /video/v1/playback-restrictions	Create a Playback Restriction
DeletePlaybackRestriction	DELETE /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}	Delete a Playback Restriction
GetPlaybackRestriction	GET /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}	Retrieve a Playback Restriction
ListPlaybackRestrictions	GET /video/v1/playback-restrictions	List Playback Restrictions
UpdateReferrerDomainRestriction	PUT /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer	Update the Referrer Playback Restriction
UpdateUserAgentRestriction	PUT /video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent	Update the User Agent Restriction

CreatePlaybackRestriction

PlaybackRestrictionResponse CreatePlaybackRestriction (CreatePlaybackRestrictionRequest createPlaybackRestrictionRequest)

Create a Playback Restriction

Create a new Playback Restriction.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class CreatePlaybackRestrictionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var createPlaybackRestrictionRequest = new CreatePlaybackRestrictionRequest(); // CreatePlaybackRestrictionRequest | 

            try
            {
                // Create a Playback Restriction
                PlaybackRestrictionResponse result = apiInstance.CreatePlaybackRestriction(createPlaybackRestrictionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.CreatePlaybackRestriction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
createPlaybackRestrictionRequest	CreatePlaybackRestrictionRequest

Return type

PlaybackRestrictionResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePlaybackRestriction

void DeletePlaybackRestriction (string PLAYBACK_RESTRICTION_ID)

Delete a Playback Restriction

Deletes a single Playback Restriction.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class DeletePlaybackRestrictionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var PLAYBACK_RESTRICTION_ID = "PLAYBACK_RESTRICTION_ID_example";  // string | ID of the Playback Restriction.

            try
            {
                // Delete a Playback Restriction
                apiInstance.DeletePlaybackRestriction(PLAYBACK_RESTRICTION_ID);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.DeletePlaybackRestriction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
PLAYBACK_RESTRICTION_ID	string	ID of the Playback Restriction.

Return type

void (empty response body)

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPlaybackRestriction

PlaybackRestrictionResponse GetPlaybackRestriction (string PLAYBACK_RESTRICTION_ID)

Retrieve a Playback Restriction

Retrieves a Playback Restriction associated with the unique identifier.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class GetPlaybackRestrictionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var PLAYBACK_RESTRICTION_ID = "PLAYBACK_RESTRICTION_ID_example";  // string | ID of the Playback Restriction.

            try
            {
                // Retrieve a Playback Restriction
                PlaybackRestrictionResponse result = apiInstance.GetPlaybackRestriction(PLAYBACK_RESTRICTION_ID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.GetPlaybackRestriction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
PLAYBACK_RESTRICTION_ID	string	ID of the Playback Restriction.

Return type

PlaybackRestrictionResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPlaybackRestrictions

ListPlaybackRestrictionsResponse ListPlaybackRestrictions (int? page = null, int? limit = null)

List Playback Restrictions

Returns a list of all Playback Restrictions.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class ListPlaybackRestrictionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var page = 1;  // int? | Offset by this many pages, of the size of `limit` (optional)  (default to 1)
            var limit = 25;  // int? | Number of items to include in the response (optional)  (default to 25)

            try
            {
                // List Playback Restrictions
                ListPlaybackRestrictionsResponse result = apiInstance.ListPlaybackRestrictions(page, limit);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.ListPlaybackRestrictions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
page	int?	Offset by this many pages, of the size of `limit`	[optional] [default to 1]
limit	int?	Number of items to include in the response	[optional] [default to 25]

Return type

ListPlaybackRestrictionsResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateReferrerDomainRestriction

PlaybackRestrictionResponse UpdateReferrerDomainRestriction (string PLAYBACK_RESTRICTION_ID, UpdateReferrerDomainRestrictionRequest updateReferrerDomainRestrictionRequest)

Update the Referrer Playback Restriction

Allows you to modify the list of domains or change how Mux validates playback requests without the Referer HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class UpdateReferrerDomainRestrictionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var PLAYBACK_RESTRICTION_ID = "PLAYBACK_RESTRICTION_ID_example";  // string | ID of the Playback Restriction.
            var updateReferrerDomainRestrictionRequest = new UpdateReferrerDomainRestrictionRequest(); // UpdateReferrerDomainRestrictionRequest | 

            try
            {
                // Update the Referrer Playback Restriction
                PlaybackRestrictionResponse result = apiInstance.UpdateReferrerDomainRestriction(PLAYBACK_RESTRICTION_ID, updateReferrerDomainRestrictionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.UpdateReferrerDomainRestriction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
PLAYBACK_RESTRICTION_ID	string	ID of the Playback Restriction.
updateReferrerDomainRestrictionRequest	UpdateReferrerDomainRestrictionRequest

Return type

PlaybackRestrictionResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserAgentRestriction

PlaybackRestrictionResponse UpdateUserAgentRestriction (string PLAYBACK_RESTRICTION_ID, UpdateUserAgentRestrictionRequest updateUserAgentRestrictionRequest)

Update the User Agent Restriction

Allows you to modify how Mux validates playback requests with different user agents. Please see Using User-Agent HTTP header for validation for more details on this feature.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class UpdateUserAgentRestrictionExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new PlaybackRestrictionsApi(config);
            var PLAYBACK_RESTRICTION_ID = "PLAYBACK_RESTRICTION_ID_example";  // string | ID of the Playback Restriction.
            var updateUserAgentRestrictionRequest = new UpdateUserAgentRestrictionRequest(); // UpdateUserAgentRestrictionRequest | 

            try
            {
                // Update the User Agent Restriction
                PlaybackRestrictionResponse result = apiInstance.UpdateUserAgentRestriction(PLAYBACK_RESTRICTION_ID, updateUserAgentRestrictionRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling PlaybackRestrictionsApi.UpdateUserAgentRestriction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
PLAYBACK_RESTRICTION_ID	string	ID of the Playback Restriction.
updateUserAgentRestrictionRequest	UpdateUserAgentRestrictionRequest

Return type

PlaybackRestrictionResponse

Authorization

accessToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PlaybackRestrictionsApi.md

Latest commit

History

PlaybackRestrictionsApi.md

File metadata and controls

Mux.Csharp.Sdk.Api.PlaybackRestrictionsApi

CreatePlaybackRestriction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeletePlaybackRestriction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetPlaybackRestriction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListPlaybackRestrictions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateReferrerDomainRestriction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UpdateUserAgentRestriction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details