2.0.1 • Published 6 years ago

youtube-streamer v2.0.1

Weekly downloads
53
License
-
Repository
github
Last release
6 years ago

Youtube

Build Status Coverage Status

This module is a implementation of Youtube Data API V3 https://developers.google.com/youtube/v3/getting-started

You need nodejs version > 7.6 because this module was made with ES6 and use Async - Await.

node --version

Installation:

Add the latest version of youtube-streamer to your package.json:

npm install -s youtube-streamer

Usage:

let youtubeApi = require('youtube-streamer');

Give the credentials of the youtube to the constructor

ParamsDescriptionOptional
clientIdThe Client Id was provided by Youtube OAuth 2.0 Clientfalse
clientSecretThe Client Secret was provided by Youtube OAuth 2.0 Clientfalse
redirectUrlThe Redirect URL that you configured in the Youtube OAuth 2.0 Client with format 'http://redirectURL'false
keyThe key was provided by Youtube Api Keyfalse
scopesThey are 3 scopes: https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.force-sslfalse
accessTokenAccess tokentrue
liveIdLive Idtrue
channelIdChannel Idtrue
let params = {
	clientId: 'clientId',
	clientSecret: 'clientSecret',
	redirectUrl: 'http://redirectURL',
	key: 'key',
	scopes: 'https://www.googleapis.com/auth/youtube.readonly https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.force-ssl'
};

let youtube = new youtubeApi(params);

Authorization

To authenticate with OAuth you will call authorizationUrl and will return an URL, you will make a request with a browser and authorizate in OAuth. After that you will be redirect to RedirectUrl and you will get a code on QueryString ?code='hjqweassxzass'

let urlAuthorization = youtube.authorizationUrl();

Get Access Token

For generate an access token and refresh token you have to call connect with the code you got on QueryString

ParamsDescriptionOptional
CodeThe code you got in the querystringfalse
youtube.connect(code);

Refresh Access Token

If you need refresh the access token, you have to call reconnect and send the refreshToken

ParamsDescriptionOptional
RefreshTokenThe refresh token you got in credentialsfalse
youtube.reconnect(refreshToken);

Get Channel:

For get your channel information you have to call getChannel

let channel = await youtube.getChannel();

Search Channel:

For get any channel or if you need a liveId you have to call searchChannel

let channel = await youtube.searchChannel();

Get Viewers:

For get live viewers you have to call getViewers

let viewers = await youtube.getViewers();

Get Live Chat:

For get live chat message you have to call liveChat

let chats = await youtube.liveChat();

Get Credentials:

All credentials you need in this api saved automatically, if you need any of these credentials call getCredentials and you will get an object

let credentials = youtube.getCredentials();
Response:
{
  accessToken,
  refreshToken,
  expiresIn,
  liveId,
  channelId
}

Async Await

If you add await to a call, the thread waits for the response. Remember the method that makes the await method () call must have the async declared

async myMethod() {
	let channel = await youtube.getChannel();

	return channel;	
}
2.0.1

6 years ago

2.0.0

6 years ago

1.2.2

6 years ago

1.2.1

7 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.0

7 years ago