https://github.com/unknownskl/xbox-xcloud-player

Xbox-Xcloud-Player is a library that can connect to an xCloud / xHome stream using WebRTC and provides an API interface for controlling the stream.
https://github.com/unknownskl/xbox-xcloud-player

Last synced: 11 days ago
JSON representation

Xbox-Xcloud-Player is a library that can connect to an xCloud / xHome stream using WebRTC and provides an API interface for controlling the stream.

• Host: GitHub
• URL: https://github.com/unknownskl/xbox-xcloud-player
• Owner: unknownskl
• Created: 2021-09-13T17:10:52.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T19:42:12.000Z (5 months ago)
• Last Synced: 2024-05-29T13:24:26.024Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.72 MB
• Stars: 140
• Watchers: 9
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Xbox-xCloud-Player

Xbox-Xcloud-Player is a library that can connect to an xCloud / xHome stream using WebRTC and provides an API interface for controlling the stream.

## Install

Add the xbox-cloud-player package using npm or yarn:

    npm install xbox-cloud-player --save

## Local development

### Requirements

    - NodeJS

    - npm

### Steps to get up and running

Clone the repository:

    git clone https://github.com/unknownskl/xbox-xcloud-player.git

    cd xbox-xcloud-player

Install dependencies:

    npm ci

Login to Gamepass using your Xbox Account:

    npm run auth

Run development build in watch mode:

    npm run watch

Create production build:

    npm run build

### API

There are several API's available. The 2 main API's you want to use are the ApiClient and Player.

## ApiClient

Create new ApiClient for API requests

    import xCloudPlayer from 'xbox-xcloud-player'

    const ApiClient = new xCloudPlayer.ApiClient({ locale: 'en-US', host: 'https://uks.core.gssv-play-prodxhome.xboxlive.com', token: '' })

    const consoles = ApiClient.getConsoles().then((consoles) => {

        console.log('Consoles:', consoles)

    })

## Player

    import xCloudPlayer from 'xbox-xcloud-player'

    const ApiClient = new xCloudPlayer.Player()