@sighmir/jsmixer
v1.3.5
Published
Javascript Mixer API
Downloads
6
Readme
jsMixer
jsMixer is a Javascript module for working with the Mixer API.
Requirements
- Tested against Mixer REST API v1.0 and Chat API v2.
- For Node.js you will need the xmlhttprequest library.
Documentation
Getting Started
If you are using Node.js, install jsMixer using npm:
$ npm install @sighmir/jsmixer
You can now require and use jsmixer like so:
let { MixerAPI } = require('@sighmir/jsmixer')
const MIXER_CLIENT = process.env.MIXER_CLIENT
const MIXER_SECRET = process.env.MIXER_SECRET
let mapi = new MixerAPI(MIXER_CLIENT, MIXER_SECRET, ['chat:connect', 'chat:chat'])
mapi.auth().then(async () => {
let user = await mapi.getCurrentUser()
let chat = await mapi.getChat(user.channel.id)
chat = await mapi.join(user.channel, chat)
console.log(`Connected to ${user.channel.token}`)
chat.msg('Hello World!')
chat.addMessageHandler((data) => {
console.log(`${data.user_name}: ${data.message.message[0].text}`)
})
let chatters = await mapi.getChatChatters(user.channel.id)
console.log('Chatters: ', chatters)
}).catch(e => console.log(e))
Refer to the Mixer API Documentation, Chat Methods, Chat Events and the jsMixer Example for more information.
Browser
You can also load this script on your browser like so:
<script src='https://cdn.jsdelivr.net/npm/@sighmir/jsmixer/lib/jsMixerChat.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@sighmir/jsmixer/lib/jsMixer.js'></script>
<script src='https://cdn.jsdelivr.net/npm/@sighmir/jsmixer/lib/jsMixerBot.js'></script>
You can now use the class MixerAPI normally on the page, like you would on Node.js.
License
jsMixer - Mixer API Javascript Library.
Copyright (C) 2019 Guilherme Caulada (Sighmir)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.