Skip to content

Commit

Permalink
v0.13.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jsanford8 committed Jun 24, 2024
1 parent 02e99e7 commit dc29c0c
Show file tree
Hide file tree
Showing 27 changed files with 1,335 additions and 63 deletions.
8 changes: 8 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ docs/CreateTrackResponse.md
docs/CreateTranscriptionVocabularyRequest.md
docs/CreateUploadRequest.md
docs/CreateWebInputRequest.md
docs/DRMConfiguration.md
docs/DRMConfigurationResponse.md
docs/DRMConfigurationsApi.md
docs/DeliveryReport.md
docs/DeliveryReportDeliveredSecondsByResolution.md
docs/DeliveryUsageApi.md
Expand Down Expand Up @@ -82,6 +85,7 @@ docs/ListAllMetricValuesResponse.md
docs/ListAssetsResponse.md
docs/ListBreakdownValuesResponse.md
docs/ListBreakdownValuesResponseMeta.md
docs/ListDRMConfigurationsResponse.md
docs/ListDeliveryUsageResponse.md
docs/ListDimensionValuesResponse.md
docs/ListDimensionsResponse.md
Expand Down Expand Up @@ -184,6 +188,7 @@ docs/WebInputResponse.md
docs/WebInputsApi.md
src/Mux.Csharp.Sdk.Test/Mux.Csharp.Sdk.Test.csproj
src/Mux.Csharp.Sdk/Api/AssetsApi.cs
src/Mux.Csharp.Sdk/Api/DRMConfigurationsApi.cs
src/Mux.Csharp.Sdk/Api/DeliveryUsageApi.cs
src/Mux.Csharp.Sdk/Api/DimensionsApi.cs
src/Mux.Csharp.Sdk/Api/DirectUploadsApi.cs
Expand Down Expand Up @@ -249,6 +254,8 @@ src/Mux.Csharp.Sdk/Model/CreateTrackResponse.cs
src/Mux.Csharp.Sdk/Model/CreateTranscriptionVocabularyRequest.cs
src/Mux.Csharp.Sdk/Model/CreateUploadRequest.cs
src/Mux.Csharp.Sdk/Model/CreateWebInputRequest.cs
src/Mux.Csharp.Sdk/Model/DRMConfiguration.cs
src/Mux.Csharp.Sdk/Model/DRMConfigurationResponse.cs
src/Mux.Csharp.Sdk/Model/DeliveryReport.cs
src/Mux.Csharp.Sdk/Model/DeliveryReportDeliveredSecondsByResolution.cs
src/Mux.Csharp.Sdk/Model/DimensionValue.cs
Expand Down Expand Up @@ -293,6 +300,7 @@ src/Mux.Csharp.Sdk/Model/ListAllMetricValuesResponse.cs
src/Mux.Csharp.Sdk/Model/ListAssetsResponse.cs
src/Mux.Csharp.Sdk/Model/ListBreakdownValuesResponse.cs
src/Mux.Csharp.Sdk/Model/ListBreakdownValuesResponseMeta.cs
src/Mux.Csharp.Sdk/Model/ListDRMConfigurationsResponse.cs
src/Mux.Csharp.Sdk/Model/ListDeliveryUsageResponse.cs
src/Mux.Csharp.Sdk/Model/ListDimensionValuesResponse.cs
src/Mux.Csharp.Sdk/Model/ListDimensionsResponse.cs
Expand Down
10 changes: 5 additions & 5 deletions Mux.Csharp.Sdk.sln
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 14
VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk", "src\Mux.Csharp.Sdk\Mux.Csharp.Sdk.csproj", "{B938D962-6319-4AA3-BBD2-067CE0E28E26}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk", "src\Mux.Csharp.Sdk\Mux.Csharp.Sdk.csproj", "{F6690C70-83FC-436A-96B7-8DE9348BD871}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk.Test", "src\Mux.Csharp.Sdk.Test\Mux.Csharp.Sdk.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
EndProject
Expand All @@ -12,10 +12,10 @@ Global
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{B938D962-6319-4AA3-BBD2-067CE0E28E26}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B938D962-6319-4AA3-BBD2-067CE0E28E26}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B938D962-6319-4AA3-BBD2-067CE0E28E26}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B938D962-6319-4AA3-BBD2-067CE0E28E26}.Release|Any CPU.Build.0 = Release|Any CPU
{F6690C70-83FC-436A-96B7-8DE9348BD871}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F6690C70-83FC-436A-96B7-8DE9348BD871}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F6690C70-83FC-436A-96B7-8DE9348BD871}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F6690C70-83FC-436A-96B7-8DE9348BD871}.Release|Any CPU.Build.0 = Release|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Mux is how developers build online video. This API encompasses both Mux Video an
**PLEASE NOTE:** This is an early build of the Mux C# SDK, as evidenced by its pre-1.0 status, but we're reasonably certain of its stability and usability against the Mux API.. Documentation is currently best-effort, but it'll improve over time! Instead of contacting Mux Support, please file an issue on this repository or email [Mux DevEx]([email protected]) for assistance.

- API version: v1
- SDK version: 0.12.0
- SDK version: 0.13.0
[https://docs.mux.com](https://docs.mux.com)

<a name="frameworks-supported"></a>
Expand Down Expand Up @@ -129,6 +129,8 @@ Class | Method | HTTP request | Description
*AssetsApi* | [**UpdateAsset**](docs/AssetsApi.md#updateasset) | **PATCH** /video/v1/assets/{ASSET_ID} | Update an asset
*AssetsApi* | [**UpdateAssetMasterAccess**](docs/AssetsApi.md#updateassetmasteraccess) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
*AssetsApi* | [**UpdateAssetMp4Support**](docs/AssetsApi.md#updateassetmp4support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
*DRMConfigurationsApi* | [**GetDrmConfiguration**](docs/DRMConfigurationsApi.md#getdrmconfiguration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration
*DRMConfigurationsApi* | [**ListDrmConfigurations**](docs/DRMConfigurationsApi.md#listdrmconfigurations) | **GET** /video/v1/drm-configurations | List DRM Configurations
*DeliveryUsageApi* | [**ListDeliveryUsage**](docs/DeliveryUsageApi.md#listdeliveryusage) | **GET** /video/v1/delivery-usage | List Usage
*DimensionsApi* | [**ListDimensionValues**](docs/DimensionsApi.md#listdimensionvalues) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
*DimensionsApi* | [**ListDimensions**](docs/DimensionsApi.md#listdimensions) | **GET** /data/v1/dimensions | List Dimensions
Expand Down Expand Up @@ -250,6 +252,8 @@ Class | Method | HTTP request | Description
- [Model.CreateTranscriptionVocabularyRequest](docs/CreateTranscriptionVocabularyRequest.md)
- [Model.CreateUploadRequest](docs/CreateUploadRequest.md)
- [Model.CreateWebInputRequest](docs/CreateWebInputRequest.md)
- [Model.DRMConfiguration](docs/DRMConfiguration.md)
- [Model.DRMConfigurationResponse](docs/DRMConfigurationResponse.md)
- [Model.DeliveryReport](docs/DeliveryReport.md)
- [Model.DeliveryReportDeliveredSecondsByResolution](docs/DeliveryReportDeliveredSecondsByResolution.md)
- [Model.DimensionValue](docs/DimensionValue.md)
Expand Down Expand Up @@ -294,6 +298,7 @@ Class | Method | HTTP request | Description
- [Model.ListAssetsResponse](docs/ListAssetsResponse.md)
- [Model.ListBreakdownValuesResponse](docs/ListBreakdownValuesResponse.md)
- [Model.ListBreakdownValuesResponseMeta](docs/ListBreakdownValuesResponseMeta.md)
- [Model.ListDRMConfigurationsResponse](docs/ListDRMConfigurationsResponse.md)
- [Model.ListDeliveryUsageResponse](docs/ListDeliveryUsageResponse.md)
- [Model.ListDimensionValuesResponse](docs/ListDimensionValuesResponse.md)
- [Model.ListDimensionsResponse](docs/ListDimensionsResponse.md)
Expand Down
3 changes: 2 additions & 1 deletion docs/CreateAssetRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Input** | [**List&lt;InputSettings&gt;**](InputSettings.md) | An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See &#x60;input[].url&#x60; for requirements. | [optional]
**PlaybackPolicy** | [**List&lt;PlaybackPolicy&gt;**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through &#x60;playback_ids&#x60;. Options include: &#x60;\&quot;public\&quot;&#x60; (anyone with the playback URL can stream the asset). And &#x60;\&quot;signed\&quot;&#x60; (an additional access token is required to play the asset). If no playback_policy is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional]
**PlaybackPolicy** | [**List&lt;PlaybackPolicy&gt;**](PlaybackPolicy.md) | An array of playback policy names that you want applied to this asset and available through &#x60;playback_ids&#x60;. Options include: * &#x60;\&quot;public\&quot;&#x60; (anyone with the playback URL can stream the asset). * &#x60;\&quot;signed\&quot;&#x60; (an additional access token is required to play the asset). If no &#x60;playback_policy&#x60; is set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. | [optional]
**AdvancedPlaybackPolicies** | [**List&lt;CreatePlaybackIDRequest&gt;**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through &#x60;playback_ids&#x60;. &#x60;advanced_playback_policies&#x60; must be used instead of &#x60;playback_policy&#x60; when creating a DRM playback ID. | [optional]
**PerTitleEncode** | **bool** | | [optional]
**Passthrough** | **string** | Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. **Max: 255 characters**. | [optional]
**Mp4Support** | **string** | Specify what level of support for mp4 playback. * The &#x60;capped-1080p&#x60; option produces a single MP4 file, called &#x60;capped-1080p.mp4&#x60;, with the video resolution capped at 1080p. This option produces an &#x60;audio.m4a&#x60; file for an audio-only asset. * The &#x60;audio-only&#x60; option produces a single M4A file, called &#x60;audio.m4a&#x60; for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The &#x60;audio-only,capped-1080p&#x60; option produces both the &#x60;audio.m4a&#x60; and &#x60;capped-1080p.mp4&#x60; files. Only the &#x60;capped-1080p.mp4&#x60; file is produced for a video-only asset, while only the &#x60;audio.m4a&#x60; file is produced for an audio-only asset. The &#x60;standard&#x60;(deprecated) option produces up to three MP4 files with different levels of resolution (&#x60;high.mp4&#x60;, &#x60;medium.mp4&#x60;, &#x60;low.mp4&#x60;, or &#x60;audio.m4a&#x60; for an audio-only asset). MP4 files are not produced for &#x60;none&#x60; (default). In most cases you should use our default HLS-based streaming playback (&#x60;{playback_id}.m3u8&#x60;) which can automatically adjust to viewers&#39; connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/CreateLiveStreamRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PlaybackPolicy** | [**List&lt;PlaybackPolicy&gt;**](PlaybackPolicy.md) | | [optional]
**AdvancedPlaybackPolicies** | [**List&lt;CreatePlaybackIDRequest&gt;**](CreatePlaybackIDRequest.md) | An array of playback policy objects that you want applied to this asset and available through &#x60;playback_ids&#x60;. &#x60;advanced_playback_policies&#x60; must be used instead of &#x60;playback_policy&#x60; when creating a DRM playback ID. | [optional]
**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
**ReconnectWindow** | **float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the &#x60;use_slate_for_standard_latency&#x60; option. | [optional] [default to 60F]
**UseSlateForStandardLatency** | **bool** | By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream. | [optional] [default to false]
Expand Down
1 change: 1 addition & 0 deletions docs/CreatePlaybackIDRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Policy** | **PlaybackPolicy** | | [optional]
**DrmConfigurationId** | **string** | The DRM configuration used by this playback ID. Must only be set when &#x60;policy&#x60; is set to &#x60;drm&#x60;. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/CreateUploadRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**Timeout** | **int** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked &#x60;timed_out&#x60; | [optional] [default to 3600]
**CorsOrigin** | **string** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional]
**NewAssetSettings** | [**CreateAssetRequest**](CreateAssetRequest.md) | | [optional]
**Test** | **bool** | | [optional]
**Test** | **bool** | Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a &#x60;test&#x60; Asset. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/DRMConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Mux.Csharp.Sdk.Model.DRMConfiguration

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | Unique identifier for the DRM Configuration. Max 255 characters. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/DRMConfigurationResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Mux.Csharp.Sdk.Model.DRMConfigurationResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**DRMConfiguration**](DRMConfiguration.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

162 changes: 162 additions & 0 deletions docs/DRMConfigurationsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# Mux.Csharp.Sdk.Api.DRMConfigurationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**GetDrmConfiguration**](DRMConfigurationsApi.md#getdrmconfiguration) | **GET** /video/v1/drm-configurations/{DRM_CONFIGURATION_ID} | Retrieve a DRM Configuration
[**ListDrmConfigurations**](DRMConfigurationsApi.md#listdrmconfigurations) | **GET** /video/v1/drm-configurations | List DRM Configurations


<a name="getdrmconfiguration"></a>
# **GetDrmConfiguration**
> DRMConfigurationResponse GetDrmConfiguration (string DRM_CONFIGURATION_ID)
Retrieve a DRM Configuration

Retrieves a single DRM Configuration.

### Example
```csharp
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 GetDrmConfigurationExample
{
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 DRMConfigurationsApi(config);
var DRM_CONFIGURATION_ID = "DRM_CONFIGURATION_ID_example"; // string | The DRM Configuration ID.
try
{
// Retrieve a DRM Configuration
DRMConfigurationResponse result = apiInstance.GetDrmConfiguration(DRM_CONFIGURATION_ID);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DRMConfigurationsApi.GetDrmConfiguration: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**DRM_CONFIGURATION_ID** | **string**| The DRM Configuration ID. |

### Return type

[**DRMConfigurationResponse**](DRMConfigurationResponse.md)

### Authorization

[accessToken](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

<a name="listdrmconfigurations"></a>
# **ListDrmConfigurations**
> ListDRMConfigurationsResponse ListDrmConfigurations (int? page = null, int? limit = null)
List DRM Configurations

Returns a list of DRM Configurations

### Example
```csharp
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 ListDrmConfigurationsExample
{
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 DRMConfigurationsApi(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 DRM Configurations
ListDRMConfigurationsResponse result = apiInstance.ListDrmConfigurations(page, limit);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DRMConfigurationsApi.ListDrmConfigurations: " + 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 &#x60;limit&#x60; | [optional] [default to 1]
**limit** | **int?**| Number of items to include in the response | [optional] [default to 25]

### Return type

[**ListDRMConfigurationsResponse**](ListDRMConfigurationsResponse.md)

### Authorization

[accessToken](../README.md#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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Loading

0 comments on commit dc29c0c

Please sign in to comment.