### Get started (Android)

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

Guides for getting started with JW Player on Android.

```APIDOC
## GET /websites/jwplayer_players

### Description
Provides instructions for getting started with JW Player on Android, including SDK integration and ProGuard configuration.

### Method
GET

### Endpoint
/websites/jwplayer_players

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **content** (object) - Details about getting started with JW Player for Android.

#### Response Example
```json
{
  "content": {
    "ce": false,
    "project": "6226757f9155ed002e07aba4",
    "version": "6226757f9155ed002e07aba0",
    "createdAt": "2022-04-14T21:10:30.054Z",
    "__v": 0,
    "pages": [
      {
        "_id": "63489864365185007e573de0",
        "api": {
          "method": "get",
          "url": "",
          "auth": "required",
          "results": {
            "codes": [
              {
                "name": "",
                "code": "{}",
                "language": "json",
                "status": 200
              },
              {
                "name": "",
                "code": "{}",
                "language": "json",
                "status": 400
              }
            ]
          },
          "params": []
        },
        "title": "Get started (Android)",
        "icon": "",
        "type": "basic",
        "slug": "android-firetv-get-started",
        "order": 2,
        "isReference": false,
        "deprecated": false,
        "hidden": false,
        "sync_unique": "",
        "link_url": "",
        "link_external": false,
        "previousSlug": "amdroid-firetv-get-started",
        "createdAt": "2022-10-13T22:59:48.573Z",
        "category": "62588dc6f83b2a0014a4afdc",
        "parentDoc": null,
        "isBodyEmpty": true,
        "children": [
          {
            "_id": "64149f6e04ffba0018f648d2",
            "api": {
              "method": "get",
              "url": "",
              "auth": "required",
              "results": {
                "codes": [
                  {
                    "name": "",
                    "code": "{}",
                    "language": "json",
                    "status": 200
                  },
                  {
                    "name": "",
                    "code": "{}",
                    "language": "json",
                    "status": 400
                  }
                ]
              },
              "params": [],
              "examples": {
                "codes": []
              }
            },
            "title": "Add the SDK (Android)",
            "icon": "",
            "type": "basic",
            "slug": "android-add-the-sdk",
            "order": 0,
            "isReference": false,
            "deprecated": false,
            "hidden": false,
            "sync_unique": "",
            "link_url": "",
            "link_external": false,
            "previousSlug": "deprecate-add-the-sdk-android",
            "parentDoc": "63489864365185007e573de0",
            "category": "62588dc6f83b2a0014a4afdc",
            "createdAt": "2023-03-17T17:12:14.309Z",
            "mdx": {},
            "isBodyEmpty": false,
            "children": []
          },
          {
            "_id": "64149f8d1e7d3b006559d278",
            "api": {
              "method": "get",
              "url": "",
              "auth": "required",
              "results": {
                "codes": [
                  {
                    "name": "",
                    "code": "{}",
                    "language": "json",
                    "status": 200
                  },
                  {
                    "name": "",
                    "code": "{}",
                    "language": "json",
                    "status": 400
                  }
                ]
              },
              "params": [],
              "examples": {
                "codes": []
              }
            },
            "title": "Configure ProGuard (Android)",
            "icon": "",
            "type": "basic",
            "slug": "android-configure-proguard",
            "order": 1,
            "isReference": false,
            "deprecated": false,
            "hidden": false,
            "sync_unique": "",
            "link_url": "",
            "link_external": false,
            "previousSlug": "deprecate-configure-proguard-android",
            "parentDoc": "63489864365185007e573de0",
            "category": "62588dc6f83b2a0014a4afdc",
            "createdAt": "2023-03-17T17:12:45.870Z",
            "isBodyEmpty": false,
            "children": []
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Get started (Android)

Source: https://docs.jwplayer.com/players/reference

Guides for getting started with JW Player on Android.

```APIDOC
## GET /websites/jwplayer_players

### Description
Provides instructions for getting started with JW Player on Android, including SDK integration and configuration.

### Method
GET

### Endpoint
/websites/jwplayer_players

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **title** (string) - The title of the getting started guide.
- **slug** (string) - The slug for the guide.
- **api** (object) - API details for related endpoints.

#### Response Example
```json
{
  "_id": "63489864365185007e573de0",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Get started (Android)",
  "icon": "",
  "type": "basic",
  "slug": "android-firetv-get-started",
  "order": 2,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "amdroid-firetv-get-started",
  "createdAt": "2022-10-13T22:59:48.573Z",
  "category": "62588dc6f83b2a0014a4afdc",
  "parentDoc": null,
  "isBodyEmpty": true,
  "children": [
    {
      "_id": "64149f6e04ffba0018f648d2",
      "api": {
        "method": "get",
        "url": "",
        "auth": "required",
        "results": {
          "codes": [
            {
              "name": "",
              "code": "{}",
              "language": "json",
              "status": 200
            },
            {
              "name": "",
              "code": "{}",
              "language": "json",
              "status": 400
            }
          ]
        },
        "params": [],
        "examples": {
          "codes": []
        }
      },
      "title": "Add the SDK (Android)",
      "icon": "",
      "type": "basic",
      "slug": "android-add-the-sdk",
      "order": 0,
      "isReference": false,
      "deprecated": false,
      "hidden": false,
      "sync_unique": "",
      "link_url": "",
      "link_external": false,
      "previousSlug": "deprecate-add-the-sdk-android",
      "parentDoc": "63489864365185007e573de0",
      "category": "62588dc6f83b2a0014a4afdc",
      "createdAt": "2023-03-17T17:12:14.309Z",
      "mdx": {},
      "isBodyEmpty": false,
      "children": []
    },
    {
      "_id": "64149f8d1e7d3b006559d278",
      "api": {
        "method": "get",
        "url": "",
        "auth": "required",
        "results": {
          "codes": [
            {
              "name": "",
              "code": "{}",
              "language": "json",
              "status": 200
            },
            {
              "name": "",
              "code": "{}",
              "language": "json",
              "status": 400
            }
          ]
        },
        "params": [],
        "examples": {
          "codes": []
        }
      },
      "title": "Configure ProGuard (Android)",
      "icon": "",
      "type": "basic",
      "slug": "android-configure-proguard",
      "order": 1,
      "isReference": false,
      "deprecated": false,
      "hidden": false,
      "sync_unique": "",
      "link_url": "",
      "link_external": false,
      "previousSlug": "deprecate-configure-proguard-android",
      "parentDoc": "63489864365185007e573de0",
      "category": "62588dc6f83b2a0014a4afdc",
      "createdAt": "2023-03-17T17:12:45.870Z",
      "isBodyEmpty": false,
      "children": []
    },
    {
      "_id": "64149fafddd60f000ac41785",
      "api": {
        "method": "get"
      }
    }
  ]
}
```
```

--------------------------------

### iOS Get Started

Source: https://docs.jwplayer.com/players/reference/resize-eventsd

Get started guide for the iOS SDK.

```APIDOC
## GET /websites/jwplayer_players/ios-sdk-v4/ios-tvos-get-started

### Description
Get started guide for the iOS SDK.

### Method
GET

### Endpoint
/websites/jwplayer_players/ios-sdk-v4/ios-tvos-get-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Contains get started guide details.

#### Response Example
```json
{
  "data": {}
}
```
```

--------------------------------

### Configuration Options - Getting Started API

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

This endpoint provides guidance on getting started with JW Player configuration options. It requires authentication.

```APIDOC
## GET /websites/jwplayer_players/configuration-options/getting-started

### Description
Provides instructions and information for getting started with JW Player configuration options.

### Method
GET

### Endpoint
/websites/jwplayer_players/configuration-options/getting-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (object) - Getting started information.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (object) - Error details.
```

--------------------------------

### Get Started (Android)

Source: https://docs.jwplayer.com/players/reference/resize-eventsd

Guides for getting started with the JW Player SDK for Android, including FireTV.

```APIDOC
## GET /android-firetv-get-started

### Description
This endpoint provides guidance and instructions for developers to get started with the JW Player SDK for Android, specifically including integration with Amazon FireTV.

### Method
GET

### Endpoint
/android-firetv-get-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (json) - Contains getting started information for the Android SDK.

#### Response Example
```json
{}
```
```

--------------------------------

### Configuration Options - Getting Started

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Provides an overview of how to get started with JW Player configuration options.

```APIDOC
## GET /websites/jwplayer_players/configuration-options/getting-started

### Description
Introduces the basic steps and concepts for configuring the JW Player.

### Method
GET

### Endpoint
/websites/jwplayer_players/configuration-options/getting-started

### Parameters
(No specific parameters documented for this endpoint.)

### Request Example
(No specific request example provided.)

### Response
#### Success Response (200)
- **content** (string) - Markdown content explaining how to get started with JW Player configuration.

#### Response Example
```json
{
  "content": "# Getting Started with JW Player Configuration\n\nTo configure your JW Player, you can pass an options object during player initialization..."
}
```
```

--------------------------------

### GET /configuration-options/getting-started

Source: https://docs.jwplayer.com/players/reference

Provides information on getting started with JW Player configuration. Requires authentication.

```APIDOC
## GET /configuration-options/getting-started

### Description
Provides information on getting started with JW Player configuration. Requires authentication.

### Method
GET

### Endpoint
/configuration-options/getting-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Description of the response object (empty in this case)

#### Response Example
```json
{
  "example": "{}"
}
```

#### Error Response (400)
- **(object)** - Description of the error response object (empty in this case)

#### Response Example
```json
{
  "example": "{}"
}
```
```

--------------------------------

### iOS SDK Get Started

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Guides for getting started with the iOS SDK, including adding the SDK and configuring your project.

```APIDOC
## GET /websites/jwplayer_players/ios-sdk-v4/ios-tvos-get-started

### Description
Guides for getting started with the iOS SDK.

### Method
GET

### Endpoint
/websites/jwplayer_players/ios-sdk-v4/ios-tvos-get-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (object) - Get started guide details.

#### Response Example
```json
{}
```
```

```APIDOC
## GET /websites/jwplayer_players/ios-sdk-v4/ios-add-the-sdk

### Description
Instructions on how to add the JW Player SDK to your iOS project.

### Method
GET

### Endpoint
/websites/jwplayer_players/ios-sdk-v4/ios-add-the-sdk

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (object) - Details for adding the SDK.

#### Response Example
```json
{}
```
```

```APIDOC
## GET /websites/jwplayer_players/ios-sdk-v4/ios-configure-your-project

### Description
Instructions on how to configure your project for the JW Player SDK.

### Method
GET

### Endpoint
/websites/jwplayer_players/ios-sdk-v4/ios-configure-your-project

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (object) - Project configuration details.

#### Response Example
```json
{}
```
```

--------------------------------

### GET /websites/jwplayer_players/configuration-options-getting-started

Source: https://docs.jwplayer.com/players/reference/resize-eventsd

Provides information and guidance on getting started with JW Player configuration options for websites.

```APIDOC
## GET /websites/jwplayer_players/configuration-options-getting-started

### Description
This endpoint provides foundational information for configuring JW Player on your website. It covers the initial setup and essential parameters to get you started.

### Method
GET

### Endpoint
/websites/jwplayer_players/configuration-options-getting-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **code** (json) - An empty JSON object representing a successful response.

#### Response Example
```json
{}
```
```

--------------------------------

### Get Started with Web Players

Source: https://docs.jwplayer.com/players/reference/resize-eventsd

This endpoint provides introductory information on how to get started with JW Player web players.

```APIDOC
## GET /websites/jwplayer_players/get-started-with-web-players

### Description
Provides introductory information on how to get started with JW Player web players.

### Method
GET

### Endpoint
/websites/jwplayer_players/get-started-with-web-players

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **content** (object) - The content of the documentation page.

#### Response Example
```json
{
  "content": "..."
}
```
```

--------------------------------

### Example Player Setup with Advertising

Source: https://docs.jwplayer.com/players/reference/configuration-options-getting-started

Use this snippet to set up a JW Player instance with a playlist, autostart behavior, and specific advertising configurations. Ensure your license supports advanced advertising options.

```javascript
jwplayer("myElement").setup({
    "playlist": "https://cdn.jwplayer.com/v2/media/hWF9vG66",
    "autostart": "viewable",
    "advertising": {
        "client": "vast",
        "tag": "http://adserver.com/vastTag.xml"
    }
});
```

--------------------------------

### JW Player Setup with Full Configuration

Source: https://docs.jwplayer.com/players/docs/add-a-self-hosted-player

This example demonstrates how to initialize JW Player with a wide range of configuration options, including advertising, captions, skinning, and playlist. Ensure you replace placeholders like {PLAYER_FOLDER}, {LICENSE_KEY}, and {json_or_rss_url} with your actual values.

```html
<!DOCTYPE html>
<html lang="en">

<head>
    <script src="https://www.yourdomain.com/{PLAYER_FOLDER}/jwplayer.js"></script>
    <script>
        jwplayer.key = "{LICENSE_KEY}";
    </script>
</head>

<body>
    <div id="myElement"></div>

    <script>
        jwplayer("myElement").setup({
            advertising: {
                admessage: "This video will resume in xx seconds",
                adscheduleid: "nmQspR5F",
                autoplayadsmuted: false,
                cuetext: "Advertisement",
                enablePPS: false,
                endstate: "suspended",
                outstream: false,
                preloadAds: false,
                skipmessage: "Skip ad in xx seconds",
                vpaidcontrols: false
            },
            aspectratio: "16:9",
            autoPause: {
                viewability: false
            },
            autostart: false,
            captions: {
                backgroundColor: "#000000",
                backgroundOpacity: 75,
                color: "#ffffff",
                edgeStyle: "dropshadow",
                fontFamily: "sans-serif",
                fontOpacity: 100,
                fontSize: 15,
                windowColor: "#000000",
                windowOpacity: 0
            },
            controls: true,
            displayHeading: false,
            displaydescription: true,
            displaytitle: true,
            floating: {
                mode: "never"
            },
            generateSEOMetadata: false,
            height: 270,
            include_compatibility_script: false,
            interactive: false,
            intl: {
                en: {
                    advertising: {
                        admessage: "",
                        cuetext: "",
                        skipmessage: ""
                    },
                    sharing: {
                        heading: "Share Video"
                    }
                }
            },
            logo: {
                hide: false,
                position: "top-right"
            },
            mute: false,
            pipIcon: "disabled",
            playbackRateControls: false,
            preload: "none",
            related: {
                onclick: "play"
            },
            repeat: false,
            sharing: {
                code: "",
                sites: []
            },
            skin: {
                controlbar: {
                    background: "rgba(0, 0, 0, 0)",
                    icons: "rgba(255, 255, 255, 0.8)",
                    iconsActive: "#ffffff",
                    text: "#ffffff"
                },
                menus: {
                    background: "#333333",
                    text: "rgba(255,255,255,0.8)",
                    textActive: "#FFFFFF"
                },
                timeslider: {
                    progress: "#f2f2f2",
                    rail: "rgba(255, 255, 255, 0.3)"
                },
                tooltips: {
                    background: "#FFFFFF",
                    text: "#000000"
                }
            },
            stretching: "uniform",
            width: "100%",
            playlist: "{json_or_rss_url}"
        });
    </script>
</body>

</html>
```

--------------------------------

### JW Player Setup with Configuration Options

Source: https://docs.jwplayer.com/players/docs/players-troubleshoot-your-player-setup

A functional JWX configuration example. This demonstrates setting up a player instance with file, height, RTMP secure token, and disabling controls. Ensure this code runs after the player library is included.

```javascript
var playerInstance = jwplayer("myElement");
playerInstance.setup({
file: 'test.smil',
height: 400,
rtmp: {
securetoken: 'abcdefg'
},
controls: false
});
```

--------------------------------

### Web Player - Get started

Source: https://docs.jwplayer.com/players/reference

Guides users on how to get started with JW Player web players.

```APIDOC
## GET /websites/jwplayer_players/web-player/get-started-with-web-players

### Description
This endpoint provides instructions and guidance on how to get started with creating and implementing JW Player web players.

### Method
GET

### Endpoint
/websites/jwplayer_players/web-player/get-started-with-web-players

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (json) - An empty JSON object indicating success.

#### Response Example
```json
{}
```
```

--------------------------------

### GET /websites/jwplayer_players/setup-options

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Retrieves setup options for JW Player.

```APIDOC
## GET /websites/jwplayer_players/setup-options

### Description
Retrieves specific setup options for JW Player.

### Method
GET

### Endpoint
/websites/jwplayer_players/setup-options

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code.
- **codes** (array) - An array of setup code objects.
  - **name** (string) - Name of the setup code.
  - **code** (string) - The setup code itself.
  - **language** (string) - The language of the code (e.g., 'json').
  - **status** (integer) - The status code associated with the code.

#### Response Example
```json
{
  "status": 200,
  "codes": [
    {
      "name": "",
      "code": "{}",
      "language": "json",
      "status": 200
    },
    {
      "name": "",
      "code": "{}",
      "language": "json",
      "status": 400
    }
  ]
}
```
```

--------------------------------

### GET /setup-options

Source: https://docs.jwplayer.com/players/reference

Retrieves setup options for JW Player. Requires authentication.

```APIDOC
## GET /setup-options

### Description
Retrieves setup options for JW Player. Requires authentication.

### Method
GET

### Endpoint
/setup-options

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Description of the response object (empty in this case)

#### Response Example
```json
{
  "example": "{}"
}
```

#### Error Response (400)
- **(object)** - Description of the error response object (empty in this case)

#### Response Example
```json
{
  "example": "{}"
}
```
```

--------------------------------

### GET /api/web-player/get-started-with-web-players

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Provides instructions on how to get started with JW Player web players.

```APIDOC
## GET /api/web-player/get-started-with-web-players

### Description
Provides a guide on how to get started with JW Player web players, including basic setup and integration steps.

### Method
GET

### Endpoint
/api/web-player/get-started-with-web-players

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **guide** (string) - A markdown formatted guide for getting started with web players.

#### Response Example
```json
{
  "guide": "# Getting Started with JW Player Web Players\n\n1. Include the JW Player script..."
}
```
```

--------------------------------

### Setup Player with Configuration (Java)

Source: https://docs.jwplayer.com/players/docs/android-set-up-a-player

Initialize the JWPlayer instance with the `PlayerConfig` object. This loads the playlist and prepares the player for playback.

```java
mPlayer.setup(config);
```

--------------------------------

### Android SDK v4 Documentation

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Documentation for the JW Player Android SDK v4, including overview and getting started guides.

```APIDOC
## GET /websites/jwplayer_players/android-sdk-v4

### Description
Provides documentation and guides for the JW Player Android SDK v4.

### Method
GET

### Endpoint
/websites/jwplayer_players/android-sdk-v4

### Parameters
This endpoint does not have specific query parameters documented here, but sub-pages might.

### Request Example
```json
{
  "example": "GET /websites/jwplayer_players/android-sdk-v4"
}
```

### Response
#### Success Response (200)
- **_id** (string) - Unique identifier for the Android SDK documentation.
- **title** (string) - The title of the documentation section (e.g., "Android").
- **slug** (string) - URL-friendly identifier for the Android SDK (e.g., "android-sdk-v4").
- **order** (integer) - Display order for this section.
- **reference** (boolean) - Indicates if this is a reference section.
- **project** (string) - The project ID this documentation belongs to.
- **version** (string) - The version of the SDK (e.g., "6226757f9155ed002e07aba0").
- **createdAt** (string) - Creation date and time.
- **pages** (array) - An array of documentation pages within this section.
  - **_id** (string) - Unique identifier for the page.
  - **api** (object) - API details for the page (if applicable).
    - **method** (string) - HTTP method.
    - **url** (string) - API endpoint URL.
    - **auth** (string) - Authentication requirements.
    - **results** (object) - Response code details.
      - **codes** (array) - Array of status code objects.
    - **params** (array) - Array of parameter objects.
    - **examples** (object) - Example requests/responses.
  - **title** (string) - Title of the page (e.g., "Overview (Android)", "Get started (Android)").
  - **icon** (string) - Icon associated with the page.
  - **type** (string) - Type of content (e.g., 'basic').
  - **slug** (string) - URL-friendly identifier for the page.
  - **order** (integer) - Display order for the page.
  - **isReference** (boolean) - Indicates if the page is a reference.
  - **deprecated** (boolean) - Indicates if the page is deprecated.
  - **hidden** (boolean) - Indicates if the page is hidden.
  - **sync_unique** (string) - Unique sync identifier.
  - **link_url** (string) - External link URL.
  - **link_external** (boolean) - Indicates if the link is external.
  - **previousSlug** (string) - Previous slug for the page.
  - **createdAt** (string) - Creation date and time.
  - **category** (string) - Category ID.
  - **parentDoc** (string/null) - Parent document ID or null.
  - **isBodyEmpty** (boolean) - Indicates if the page body is empty.
  - **children** (array) - Child documents or pages.

#### Response Example
```json
{
  "example": "{\"_id\":\"62588dc6f83b2a0014a4afdc\",\"title\":\"Android\",\"slug\":\"android-sdk-v4\",\"order\":3,\"reference\":false,\"project\":\"6226757f9155ed002e07aba4\",\"version\":\"6226757f9155ed002e07aba0\",\"createdAt\":\"2022-04-14T21:10:30.054Z\",\"__v\":0,\"pages\":[{\"_id\":\"62db0c1201166a0162c45df8\",\"api\":{\"method\":\"get\",\"url\":\"\",\"auth\":\"required\",\"results\":{\"codes\":[{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":200},{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":400}]},\"params\":[]},\"title\":\"Overview (Android)\",\"icon\":\"\",\"type\":\"basic\",\"slug\":\"android-overview\",\"order\":0,\"isReference\":false,\"deprecated\":false,\"hidden\":false,\"sync_unique\":\"\",\"link_url\":\"\",\"link_external\":false,\"previousSlug\":\"\",\"createdAt\":\"2022-07-22T20:44:02.482Z\",\"category\":\"62588dc6f83b2a0014a4afdc\",\"parentDoc\":null,\"mdx\":{},\"isBodyEmpty\":false,\"children\":[]},{\"_id\":\"63489864365185007e573de0\",\"api\":{\"method\":\"get\",\"url\":\"\",\"auth\":\"required\",\"results\":{\"codes\":[{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":200},{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":400}]},\"params\":[]},\"title\":\"Get started (Android)\",\"icon\":\"\",\"type\":\"basic\",\"slug\":\"android-firetv-get-started\",\"order\":2,\"isReference\":false,\"deprecated\":false,\"hidden\":false,\"sync_unique\":\"\",\"link_url\":\"\",\"link_external\":false,\"previousSlug\":\"amdroid-firetv-get-started\",\"createdAt\":\"2022-10-13T22:59:48.573Z\",\"category\":\"62588dc6f83b2a0014a4afdc\",\"parentDoc\":null,\"isBodyEmpty\":true,\"children\":[{\"_id\":\"64149f6e04ffba0018f648d2\",\"api\":{\"method\":\"get\",\"url\":\"\",\"auth\":\"required\",\"results\":{\"codes\":[{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":200},{\"name\":\"\",\"code\":\"{}\",\"language\":\"json\",\"status\":400}]},\"params\":[],\"examples\":{\"codes\":[]}},\"title\":\"Add the SDK (Android)\",\"icon\":\"\",\"type\":\"basic\",\"slug\":\"android-add-the-sdk\",\"order\":0,\"isRefer"}
}
```
```

--------------------------------

### JW Player Recommendations Configuration Example

Source: https://docs.jwplayer.com/players/docs/jw8-set-up-recommendations

Example of setting up JW Player with recommendations and internationalized text.

```APIDOC
## JW Player Recommendations Configuration

### Description
This example demonstrates how to configure JW Player with recommendations, including `displayMode`, `autoplaytimer`, `oncomplete`, and internationalized text for different languages.

### Method
JavaScript

### Endpoint
N/A (Client-side configuration)

### Request Body
```javascript
jwplayer("myElement").setup({
  playlist: "https://cdn.jwplayer.com/v2/media/Ly53q8A1?recommendations_playlist_id=n29tZc01",
  nextupoffset: -10,
  related: {
    displayMode: "shelf",
    autoplaytimer: 10,
    oncomplete: "autoplay"
  },
  intl: {
    en: {
      related: {
        autoplaymessage: "__title__ will play in xx seconds",
        heading: "More Amazing Videos"
      }
    },
    fr: {
      related: {
        autoplaymessage: "__title__ commencera dans xx secondes",
        heading: "Plus de vidéos étonnantes"
      }
    }
  }
});
```

### Response
N/A (Client-side configuration)
```

--------------------------------

### JW Player Floating Player Setup

Source: https://docs.jwplayer.com/players/reference/floating

Example of setting up the JW Player with floating player configuration. This includes basic playlist setup and specific floating player options.

```APIDOC
## JW Player Floating Player Setup

### Description
This example demonstrates how to initialize the JW Player with a playlist and configure the floating player behavior. It includes options for controlling the player's visibility, dismissibility, and title display when floating.

### Method
JavaScript Initialization

### Endpoint
N/A (Client-side configuration)

### Parameters
#### Request Body (Configuration Object)
- **playlist** (string) - Required - The URL for the playlist.
- **floating** (object) - Optional - Configuration object for the floating player.
  - **mode** (string) - Optional - Determines how the floating behavior operates. Possible values: `notVisible` (default), `always`, `never`.
  - **dismissible** (boolean) - Optional - Permits or prohibits closing the floating player. Default: `true`.
  - **showTitle** (boolean) - Optional - Determines if the video title is displayed with the floating player close button. Default: `false`.

### Request Example
```javascript
jwplayer("myElement").setup({
  "playlist": "https://cdn.jwplayer.com/v2/playlists/{playlist_id}",
  "floating": {
    "mode": "notVisible",
    "dismissible": true,
    "showTitle": false
  }
});
```

### Response
N/A (Client-side configuration)

### Error Handling
N/A
```

--------------------------------

### Set up a player (iOS)

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

Guides on how to set up a JW Player within an iOS application. This section details the necessary steps to initialize and configure a player instance.

```swift
/* Code examples for setting up a player in iOS will be provided here. */
```

--------------------------------

### Setup Event Listener

Source: https://docs.jwplayer.com/players/docs/listening-for-events-web-player

This code snippet shows how to attach an event listener for the 'ready' event. This event fires when the player has been successfully initialized and is ready to be controlled.

```javascript
.on('ready')
```

--------------------------------

### Setup Errors - Miscellaneous

Source: https://docs.jwplayer.com/players/docs/jw8-player-errors-reference

These errors prevent the player from setting up successfully.

```APIDOC
## Setup Errors - Miscellaneous

### Description
These errors prevent the player from setting up successfully; they occur after `jwplayer().setup()` is called, are dispatched in a "setupError" event and prevent the dispatch of the "ready" event.

### Error Codes

| Code | Reason | Deprecated Error Message < 8.4.0 | Displayed Message |
|---|---|---|---|
| 100000 | An unknown setup error occurred. | none | Sorry, the video player failed to load. |
| 100001 | Setup took longer than 60 seconds to complete. | Setup Timeout Error: Setup took longer than 30 seconds to complete. | Sorry, the video player failed to load. |
| 100011 | Missing license key: the key was not found in the setup config or the `jwplayer.key` global. | Error setting up player: Missing license key | Sorry, the video player failed to load. |
| 100012 | Invalid license key. | Error setting up player: Invalid license key | Sorry, the video player failed to load. |
| 100013 | Expired license key. | Error setting up player: Invalid license key | Sorry, the video player failed to load. |
| 100014 | License key is not supported in unlimited edition. | - | Sorry, the video player failed to load. |
```

--------------------------------

### GET /websites/jwplayer_players/android-enable-localization

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Guide on enabling localization features for JW Player on Android.

```APIDOC
## GET /websites/jwplayer_players/android-enable-localization

### Description
This endpoint details the process of enabling and configuring localization for JW Player within an Android application, allowing for multi-language support.

### Method
GET

### Endpoint
/websites/jwplayer_players/android-enable-localization

### Parameters
(No specific parameters documented for this general guide endpoint)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- (Documentation for response structure not fully detailed in the provided text, but implies localization configuration details)
```json
{
  "message": "Localization enabled successfully"
}
```

#### Error Response (400)
- (Documentation for response structure not fully detailed in the provided text, but implies error details for invalid configurations)
```json
{
  "error": "Invalid localization configuration"
}
```
```

--------------------------------

### GET /websites/jwplayer_players/android-styling-guide

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Information regarding Android styling guides for JW Player.

```APIDOC
## GET /websites/jwplayer_players/android-styling-guide

### Description
This endpoint provides information and guides for customizing the appearance and styling of JW Player on Android devices.

### Method
GET

### Endpoint
/websites/jwplayer_players/android-styling-guide

### Parameters
(No specific parameters documented for this general guide endpoint)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- (Documentation for response structure not fully detailed in the provided text, but implies styling-related information)

#### Response Example
(Response example not available in the provided text)
```

--------------------------------

### Setup Options API

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

This endpoint details the setup options available for JW Player configurations. It requires authentication.

```APIDOC
## GET /websites/jwplayer_players/setup-options

### Description
Provides information about the setup options for JW Player.

### Method
GET

### Endpoint
/websites/jwplayer_players/setup-options

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **{}** (object) - Setup options data.

#### Response Example
```json
{}
```

#### Error Response (400)
- **{}** (object) - Error details.
```

--------------------------------

### GET /jw8-set-up-pb-for-spotx-mediation

Source: https://docs.jwplayer.com/players/reference/resize-eventsd

This endpoint covers the setup for Prebid.js mediation with SpotX on web platforms.

```APIDOC
## GET /jw8-set-up-pb-for-spotx-mediation

### Description
This endpoint outlines the procedure for configuring Prebid.js to work with SpotX for ad mediation on JW Player for web applications.

### Method
GET

### Endpoint
/jw8-set-up-pb-for-spotx-mediation

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None provided

### Response
#### Success Response (200)
- **response** (object) - Status of the SpotX mediation setup.

#### Response Example
```json
{
  "status": "configured"
}
```
```

--------------------------------

### Player Setup API

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

This section details the methods for setting up and configuring JW Player instances.

```APIDOC
## POST /players/reference/player-initiation

### Description
Initializes a JW Player instance with specified configuration options.

### Method
POST

### Endpoint
/players/reference/player-initiation

### Parameters
#### Request Body
- **options** (object) - Required - Configuration object for the player.

### Request Example
```json
{
  "options": {
    "file": "myvideo.mp4",
    "width": 640,
    "height": 360
  }
}
```

### Response
#### Success Response (200)
- **playerInstance** (object) - The initialized JW Player instance.

#### Response Example
```json
{
  "playerInstance": "[JW Player Instance Object]"
}
```
```

```APIDOC
## POST /players/reference/jwplayerdivsetup-options

### Description
Sets up the JW Player within a specified HTML div element using a configuration object.

### Method
POST

### Endpoint
/players/reference/jwplayerdivsetup-options

### Parameters
#### Request Body
- **divId** (string) - Required - The ID of the HTML div element.
- **options** (object) - Required - Configuration object for the player.

### Request Example
```json
{
  "divId": "my-player-div",
  "options": {
    "file": "another_video.mp4"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful setup.

#### Response Example
```json
{
  "message": "Player setup complete."
}
```
```

```APIDOC
## POST /players/reference/jwplayersetconfig

### Description
Updates the configuration of an existing JW Player instance.

### Method
POST

### Endpoint
/players/reference/jwplayersetconfig

### Parameters
#### Request Body
- **playerInstance** (object) - Required - The JW Player instance to update.
- **newConfig** (object) - Required - The new configuration settings.

### Request Example
```json
{
  "playerInstance": "[JW Player Instance Object]",
  "newConfig": {
    "autostart": true
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the configuration update.

#### Response Example
```json
{
  "status": "Configuration updated successfully."
}
```
```

--------------------------------

### Control Playback and Get Volume

Source: https://docs.jwplayer.com/players/docs/jw8-reference

Provides examples of controlling player playback by toggling play/pause and reporting the current volume level via links.

```html
<a href="javascript:jwplayer('myElement').play();">Toggle playback</a>
<a href="javascript:alert('The volume of the player is: ' + jwplayer('myElement').getVolume());">Report volume</a>
```

--------------------------------

### GET /api/players/android/specify-playback-start-time

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Allows specifying the playback start time for JW Player on Android devices.

```APIDOC
## GET /api/players/android/specify-playback-start-time

### Description
This endpoint enables developers to set a specific start time for video playback on JW Player for Android.

### Method
GET

### Endpoint
/api/players/android/specify-playback-start-time

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code indicating success.
- **data** (object) - Contains the response payload.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

--------------------------------

### Player Setup and Basic Usage

Source: https://docs.jwplayer.com/players/docs/jw8-reference

Demonstrates how to set up a JW Player embed and interact with it using the API.

```APIDOC
## Player Setup and Basic Usage

### Description
This section shows how to embed a JW Player and perform basic interactions using its API.

### HTML Setup Example
```html
<div id="myElement">Loading the player...</div>

<script type='text/javascript'>
  jwplayer("myElement").setup({
    playlist: "https://cdn.jwplayer.com/v2/playlists/xxxxYYYY"
  });
</script>
```

### JavaScript Interaction Examples
```html
<script>
  jwplayer("myElement").on('complete', function(){
    alert("Complete fired - Your content has completed!");
  });
</script>

<a href="javascript:jwplayer('myElement').play();">Toggle playback</a>
<a href="javascript:alert('The volume of the player is: ' + jwplayer('myElement').getVolume());">Report volume</a>
```
```

--------------------------------

### GET /api/players/android/create-a-custom-receiver

Source: https://docs.jwplayer.com/players/reference/seek-events-1

Guides on creating a custom receiver for Chromecast integration with JW Player on Android.

```APIDOC
## GET /api/players/android/create-a-custom-receiver

### Description
This endpoint provides instructions and necessary information for developers to create a custom receiver application when using JW Player with Chromecast on Android.

### Method
GET

### Endpoint
/api/players/android/create-a-custom-receiver

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code indicating success.
- **data** (object) - Contains the response payload, likely including links to documentation or code examples.

#### Response Example
```json
{
  "status": 200,
  "data": {}
}
```
```

--------------------------------

### JW Player Setup and Configuration

Source: https://docs.jwplayer.com/players/reference/configuration-options-options

Demonstrates how to initialize a JW Player instance with configuration options and manage player settings. This includes setting up the player in a specific HTML element and updating its configuration dynamically.

```javascript
jwplayer("my-player").setup({
  file: "/path/to/your/video.mp4",
  image: "/path/to/your/thumbnail.jpg",
  width: 720,
  height: 480
});

jwplayer("my-player").setConfig({
  autostart: true
});
```

--------------------------------

### Create Player Configuration (Java)

Source: https://docs.jwplayer.com/players/docs/android-set-up-a-player

Build a `PlayerConfig` object, assigning the created playlist to it. This configuration object is used to set up the player.

```java
PlayerConfig config = new PlayerConfig.Builder()
       .playlist(playlist)
       .build();
```