Skip to content

Commit

Permalink
v0.9.0 (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsanford8 committed Dec 19, 2023
1 parent 9be6953 commit 09fb891
Show file tree
Hide file tree
Showing 28 changed files with 803 additions and 131 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>com.mux</groupId>
<artifactId>mux-sdk-java</artifactId>
<version>0.8.0</version>
<version>0.9.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -58,7 +58,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
compile "com.mux:mux-sdk-java:0.8.0"
compile "com.mux:mux-sdk-java:0.9.0"
```

### Others
Expand All @@ -71,7 +71,7 @@ mvn clean package

Then manually install the following JARs:

* `target/mux-sdk-java-0.8.0.jar`
* `target/mux-sdk-java-0.9.0.jar`
* `target/lib/*.jar`

## Getting Started
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ plugins {
}

group = 'com.mux'
version = '0.8.0'
version = '0.9.0'

repositories {
mavenCentral()
Expand Down
2 changes: 2 additions & 0 deletions docs/AbridgedVideoView.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Name | Type | Description | Notes
**countryCode** | **String** | | [optional]
**viewStart** | **String** | | [optional]
**viewEnd** | **String** | | [optional]
**viewerExperienceScore** | **Float** | | [optional]
**watchTime** | **Integer** | | [optional]



22 changes: 21 additions & 1 deletion docs/AssetGeneratedSubtitleSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,27 @@ Name | Type | Description | Notes
Name | Value
---- | -----
EN | &quot;en&quot;
EN_US | &quot;en-US&quot;
ES | &quot;es&quot;
IT | &quot;it&quot;
PT | &quot;pt&quot;
DE | &quot;de&quot;
FR | &quot;fr&quot;
PL | &quot;pl&quot;
RU | &quot;ru&quot;
NL | &quot;nl&quot;
CA | &quot;ca&quot;
TR | &quot;tr&quot;
SV | &quot;sv&quot;
UK | &quot;uk&quot;
NO | &quot;no&quot;
FI | &quot;fi&quot;
SK | &quot;sk&quot;
EL | &quot;el&quot;
CS | &quot;cs&quot;
HR | &quot;hr&quot;
DA | &quot;da&quot;
RO | &quot;ro&quot;
BG | &quot;bg&quot;



5 changes: 4 additions & 1 deletion docs/DimensionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

<a name="listDimensionValues"></a>
# **listDimensionValues**
> ListDimensionValuesResponse listDimensionValues(DIMENSION_ID).limit(limit).page(page).filters(filters).timeframe(timeframe).execute();
> ListDimensionValuesResponse listDimensionValues(DIMENSION_ID).limit(limit).page(page).filters(filters).metricFilters(metricFilters).timeframe(timeframe).execute();
Lists the values for a specific dimension

Expand Down Expand Up @@ -41,12 +41,14 @@ public class Example {
Integer limit = 25; // Integer | Number of items to include in the response
Integer page = 1; // Integer | Offset by this many pages, of the size of `limit`
java.util.List<String> filters = Arrays.asList(); // java.util.List<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
java.util.List<String> metricFilters = Arrays.asList(); // java.util.List<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
java.util.List<String> timeframe = Arrays.asList(); // java.util.List<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
try {
ListDimensionValuesResponse result = apiInstance.listDimensionValues(DIMENSION_ID)
.limit(limit)
.page(page)
.filters(filters)
.metricFilters(metricFilters)
.timeframe(timeframe)
.execute();
System.out.println(result);
Expand All @@ -69,6 +71,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
**page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
**filters** | [**java.util.List&lt;String&gt;**](String.md)| Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional]
**metricFilters** | [**java.util.List&lt;String&gt;**](String.md)| Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional]
**timeframe** | [**java.util.List&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional]

### Return type
Expand Down
5 changes: 4 additions & 1 deletion docs/ErrorsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Method | HTTP request | Description

<a name="listErrors"></a>
# **listErrors**
> ListErrorsResponse listErrors().filters(filters).timeframe(timeframe).execute();
> ListErrorsResponse listErrors().filters(filters).metricFilters(metricFilters).timeframe(timeframe).execute();
List Errors

Expand Down Expand Up @@ -37,10 +37,12 @@ public class Example {

ErrorsApi apiInstance = new ErrorsApi(defaultClient);
java.util.List<String> filters = Arrays.asList(); // java.util.List<String> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
java.util.List<String> metricFilters = Arrays.asList(); // java.util.List<String> | Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, and `views`. Example: * `metric_filters[]=aggregate_startup_time>=1000`
java.util.List<String> timeframe = Arrays.asList(); // java.util.List<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`
try {
ListErrorsResponse result = apiInstance.listErrors()
.filters(filters)
.metricFilters(metricFilters)
.timeframe(timeframe)
.execute();
System.out.println(result);
Expand All @@ -60,6 +62,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filters** | [**java.util.List&lt;String&gt;**](String.md)| Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;!country:US&#x60; | [optional]
**metricFilters** | [**java.util.List&lt;String&gt;**](String.md)| Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as the set of metric ids, with the exceptions of &#x60;exits_before_video_start&#x60;, &#x60;unique_viewers&#x60;, &#x60;video_startup_failure_percentage&#x60;, and &#x60;views&#x60;. Example: * &#x60;metric_filters[]&#x3D;aggregate_startup_time&gt;&#x3D;1000&#x60; | [optional]
**timeframe** | [**java.util.List&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are... * array of epoch timestamps e.g. &#x60;timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600&#x60; * duration string e.g. &#x60;timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days&#x60; | [optional]

### Return type
Expand Down
2 changes: 1 addition & 1 deletion docs/InputSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ An array of objects that each describe an input file to be used to create the as

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For &#x60;audio&#x60; tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For &#x60;text&#x60; tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. * When creating clips from existing Mux assets, the URL is defined with &#x60;mux://assets/{asset_id}&#x60; template where &#x60;asset_id&#x60; is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional]
**url** | **String** | The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For &#x60;audio&#x60; tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For &#x60;text&#x60; tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * When creating clips from existing Mux assets, the URL is defined with &#x60;mux://assets/{asset_id}&#x60; template where &#x60;asset_id&#x60; is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input. | [optional]
**overlaySettings** | [**InputSettingsOverlaySettings**](InputSettingsOverlaySettings.md) | | [optional]
**generatedSubtitles** | [**java.util.List&lt;AssetGeneratedSubtitleSettings&gt;**](AssetGeneratedSubtitleSettings.md) | Generate subtitle tracks using automatic speech recognition using this configuration. This may only be provided for the first input object (the main input file). For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. This will create subtitles based on the audio track ingested from that main input file. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the &#x60;preparing&#x60; state when the asset transitions to &#x60;ready&#x60;. | [optional]
**startTime** | **Double** | The time offset in seconds from the beginning of the video indicating the clip&#39;s starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when &#x60;input.url&#x60; has &#x60;mux://assets/{asset_id}&#x60; format. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/LiveStream.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Name | Type | Description | Notes
**latencyMode** | [**LatencyModeEnum**](#LatencyModeEnum) | Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags. | [optional]
**test** | **Boolean** | True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours. | [optional]
**maxContinuousDuration** | **Integer** | The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours. | [optional]
**srtPassphrase** | **String** | Unique key used for encrypting a stream to a Mux SRT endpoint. | [optional]



Expand Down
Loading

0 comments on commit 09fb891

Please sign in to comment.