github.com/muxinc/mux-go@v1.1.1/docs/AssetsApi.md (about)

     1  # \AssetsApi
     2  
     3  All URIs are relative to *https://api.mux.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAsset**](AssetsApi.md#CreateAsset) | **Post** /video/v1/assets | Create an asset
     8  [**CreateAssetPlaybackId**](AssetsApi.md#CreateAssetPlaybackId) | **Post** /video/v1/assets/{ASSET_ID}/playback-ids | Create a playback ID
     9  [**CreateAssetTrack**](AssetsApi.md#CreateAssetTrack) | **Post** /video/v1/assets/{ASSET_ID}/tracks | Create an asset track
    10  [**DeleteAsset**](AssetsApi.md#DeleteAsset) | **Delete** /video/v1/assets/{ASSET_ID} | Delete an asset
    11  [**DeleteAssetPlaybackId**](AssetsApi.md#DeleteAssetPlaybackId) | **Delete** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Delete a playback ID
    12  [**DeleteAssetTrack**](AssetsApi.md#DeleteAssetTrack) | **Delete** /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID} | Delete an asset track
    13  [**GetAsset**](AssetsApi.md#GetAsset) | **Get** /video/v1/assets/{ASSET_ID} | Retrieve an asset
    14  [**GetAssetInputInfo**](AssetsApi.md#GetAssetInputInfo) | **Get** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
    15  [**GetAssetPlaybackId**](AssetsApi.md#GetAssetPlaybackId) | **Get** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
    16  [**ListAssets**](AssetsApi.md#ListAssets) | **Get** /video/v1/assets | List assets
    17  [**UpdateAssetMasterAccess**](AssetsApi.md#UpdateAssetMasterAccess) | **Put** /video/v1/assets/{ASSET_ID}/master-access | Update master access
    18  [**UpdateAssetMp4Support**](AssetsApi.md#UpdateAssetMp4Support) | **Put** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
    19  
    20  
    21  # **CreateAsset**
    22  > AssetResponse CreateAsset(ctx, createAssetRequest)
    23  Create an asset
    24  
    25  Create a new Mux Video asset.
    26  
    27  ### Required Parameters
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    32    **createAssetRequest** | [**CreateAssetRequest**](CreateAssetRequest.md)|  | 
    33  
    34  ### Return type
    35  
    36  [**AssetResponse**](AssetResponse.md)
    37  
    38  ### Authorization
    39  
    40  [accessToken](../README.md#accessToken)
    41  
    42  ### HTTP request headers
    43  
    44   - **Content-Type**: application/json
    45   - **Accept**: application/json
    46  
    47  [[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)
    48  
    49  # **CreateAssetPlaybackId**
    50  > CreatePlaybackIdResponse CreateAssetPlaybackId(ctx, aSSETID, createPlaybackIdRequest)
    51  Create a playback ID
    52  
    53  ### Required Parameters
    54  
    55  Name | Type | Description  | Notes
    56  ------------- | ------------- | ------------- | -------------
    57   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    58    **aSSETID** | **string**| The asset ID. | 
    59    **createPlaybackIdRequest** | [**CreatePlaybackIdRequest**](CreatePlaybackIdRequest.md)|  | 
    60  
    61  ### Return type
    62  
    63  [**CreatePlaybackIdResponse**](CreatePlaybackIDResponse.md)
    64  
    65  ### Authorization
    66  
    67  [accessToken](../README.md#accessToken)
    68  
    69  ### HTTP request headers
    70  
    71   - **Content-Type**: application/json
    72   - **Accept**: application/json
    73  
    74  [[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)
    75  
    76  # **CreateAssetTrack**
    77  > CreateTrackResponse CreateAssetTrack(ctx, aSSETID, createTrackRequest)
    78  Create an asset track
    79  
    80  ### Required Parameters
    81  
    82  Name | Type | Description  | Notes
    83  ------------- | ------------- | ------------- | -------------
    84   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    85    **aSSETID** | **string**| The asset ID. | 
    86    **createTrackRequest** | [**CreateTrackRequest**](CreateTrackRequest.md)|  | 
    87  
    88  ### Return type
    89  
    90  [**CreateTrackResponse**](CreateTrackResponse.md)
    91  
    92  ### Authorization
    93  
    94  [accessToken](../README.md#accessToken)
    95  
    96  ### HTTP request headers
    97  
    98   - **Content-Type**: application/json
    99   - **Accept**: application/json
   100  
   101  [[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)
   102  
   103  # **DeleteAsset**
   104  > DeleteAsset(ctx, aSSETID)
   105  Delete an asset
   106  
   107  Deletes a video asset and all its data.
   108  
   109  ### Required Parameters
   110  
   111  Name | Type | Description  | Notes
   112  ------------- | ------------- | ------------- | -------------
   113   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   114    **aSSETID** | **string**| The asset ID. | 
   115  
   116  ### Return type
   117  
   118   (empty response body)
   119  
   120  ### Authorization
   121  
   122  [accessToken](../README.md#accessToken)
   123  
   124  ### HTTP request headers
   125  
   126   - **Content-Type**: Not defined
   127   - **Accept**: Not defined
   128  
   129  [[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)
   130  
   131  # **DeleteAssetPlaybackId**
   132  > DeleteAssetPlaybackId(ctx, aSSETID, pLAYBACKID)
   133  Delete a playback ID
   134  
   135  ### Required Parameters
   136  
   137  Name | Type | Description  | Notes
   138  ------------- | ------------- | ------------- | -------------
   139   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   140    **aSSETID** | **string**| The asset ID. | 
   141    **pLAYBACKID** | **string**| The live stream's playback ID. | 
   142  
   143  ### Return type
   144  
   145   (empty response body)
   146  
   147  ### Authorization
   148  
   149  [accessToken](../README.md#accessToken)
   150  
   151  ### HTTP request headers
   152  
   153   - **Content-Type**: Not defined
   154   - **Accept**: Not defined
   155  
   156  [[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)
   157  
   158  # **DeleteAssetTrack**
   159  > DeleteAssetTrack(ctx, aSSETID, tRACKID)
   160  Delete an asset track
   161  
   162  Removes a text track from an asset. Audio and video tracks on assets cannot be removed.
   163  
   164  ### Required Parameters
   165  
   166  Name | Type | Description  | Notes
   167  ------------- | ------------- | ------------- | -------------
   168   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   169    **aSSETID** | **string**| The asset ID. | 
   170    **tRACKID** | **string**| The track ID. | 
   171  
   172  ### Return type
   173  
   174   (empty response body)
   175  
   176  ### Authorization
   177  
   178  [accessToken](../README.md#accessToken)
   179  
   180  ### HTTP request headers
   181  
   182   - **Content-Type**: Not defined
   183   - **Accept**: Not defined
   184  
   185  [[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)
   186  
   187  # **GetAsset**
   188  > AssetResponse GetAsset(ctx, aSSETID)
   189  Retrieve an asset
   190  
   191  Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.
   192  
   193  ### Required Parameters
   194  
   195  Name | Type | Description  | Notes
   196  ------------- | ------------- | ------------- | -------------
   197   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   198    **aSSETID** | **string**| The asset ID. | 
   199  
   200  ### Return type
   201  
   202  [**AssetResponse**](AssetResponse.md)
   203  
   204  ### Authorization
   205  
   206  [accessToken](../README.md#accessToken)
   207  
   208  ### HTTP request headers
   209  
   210   - **Content-Type**: Not defined
   211   - **Accept**: application/json
   212  
   213  [[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)
   214  
   215  # **GetAssetInputInfo**
   216  > GetAssetInputInfoResponse GetAssetInputInfo(ctx, aSSETID)
   217  Retrieve asset input info
   218  
   219  Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input.
   220  
   221  ### Required Parameters
   222  
   223  Name | Type | Description  | Notes
   224  ------------- | ------------- | ------------- | -------------
   225   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   226    **aSSETID** | **string**| The asset ID. | 
   227  
   228  ### Return type
   229  
   230  [**GetAssetInputInfoResponse**](GetAssetInputInfoResponse.md)
   231  
   232  ### Authorization
   233  
   234  [accessToken](../README.md#accessToken)
   235  
   236  ### HTTP request headers
   237  
   238   - **Content-Type**: Not defined
   239   - **Accept**: application/json
   240  
   241  [[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)
   242  
   243  # **GetAssetPlaybackId**
   244  > GetAssetPlaybackIdResponse GetAssetPlaybackId(ctx, aSSETID, pLAYBACKID)
   245  Retrieve a playback ID
   246  
   247  ### Required Parameters
   248  
   249  Name | Type | Description  | Notes
   250  ------------- | ------------- | ------------- | -------------
   251   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   252    **aSSETID** | **string**| The asset ID. | 
   253    **pLAYBACKID** | **string**| The live stream's playback ID. | 
   254  
   255  ### Return type
   256  
   257  [**GetAssetPlaybackIdResponse**](GetAssetPlaybackIDResponse.md)
   258  
   259  ### Authorization
   260  
   261  [accessToken](../README.md#accessToken)
   262  
   263  ### HTTP request headers
   264  
   265   - **Content-Type**: Not defined
   266   - **Accept**: application/json
   267  
   268  [[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)
   269  
   270  # **ListAssets**
   271  > ListAssetsResponse ListAssets(ctx, optional)
   272  List assets
   273  
   274  List all Mux assets.
   275  
   276  ### Required Parameters
   277  
   278  Name | Type | Description  | Notes
   279  ------------- | ------------- | ------------- | -------------
   280   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   281   **optional** | ***ListAssetsOpts** | optional parameters | nil if no parameters
   282  
   283  ### Optional Parameters
   284  Optional parameters are passed through a pointer to a ListAssetsOpts struct
   285  
   286  Name | Type | Description  | Notes
   287  ------------- | ------------- | ------------- | -------------
   288   **limit** | **optional.Int32**| Number of items to include in the response | [default to 25]
   289   **page** | **optional.Int32**| Offset by this many pages, of the size of `limit` | [default to 1]
   290   **liveStreamId** | **optional.String**| Filter response to return all the assets for this live stream only | 
   291   **uploadId** | **optional.String**| Filter response to return an asset created from this direct upload only | 
   292  
   293  ### Return type
   294  
   295  [**ListAssetsResponse**](ListAssetsResponse.md)
   296  
   297  ### Authorization
   298  
   299  [accessToken](../README.md#accessToken)
   300  
   301  ### HTTP request headers
   302  
   303   - **Content-Type**: Not defined
   304   - **Accept**: application/json
   305  
   306  [[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)
   307  
   308  # **UpdateAssetMasterAccess**
   309  > AssetResponse UpdateAssetMasterAccess(ctx, aSSETID, updateAssetMasterAccessRequest)
   310  Update master access
   311  
   312  Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
   313  
   314  ### Required Parameters
   315  
   316  Name | Type | Description  | Notes
   317  ------------- | ------------- | ------------- | -------------
   318   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   319    **aSSETID** | **string**| The asset ID. | 
   320    **updateAssetMasterAccessRequest** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md)|  | 
   321  
   322  ### Return type
   323  
   324  [**AssetResponse**](AssetResponse.md)
   325  
   326  ### Authorization
   327  
   328  [accessToken](../README.md#accessToken)
   329  
   330  ### HTTP request headers
   331  
   332   - **Content-Type**: application/json
   333   - **Accept**: application/json
   334  
   335  [[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)
   336  
   337  # **UpdateAssetMp4Support**
   338  > AssetResponse UpdateAssetMp4Support(ctx, aSSETID, updateAssetMp4SupportRequest)
   339  Update MP4 support
   340  
   341  Allows you to add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, `standard` and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.
   342  
   343  ### Required Parameters
   344  
   345  Name | Type | Description  | Notes
   346  ------------- | ------------- | ------------- | -------------
   347   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   348    **aSSETID** | **string**| The asset ID. | 
   349    **updateAssetMp4SupportRequest** | [**UpdateAssetMp4SupportRequest**](UpdateAssetMp4SupportRequest.md)|  | 
   350  
   351  ### Return type
   352  
   353  [**AssetResponse**](AssetResponse.md)
   354  
   355  ### Authorization
   356  
   357  [accessToken](../README.md#accessToken)
   358  
   359  ### HTTP request headers
   360  
   361   - **Content-Type**: application/json
   362   - **Accept**: application/json
   363  
   364  [[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)
   365