Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›overwolf.logitech

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

overwolf.logitech.arx API

An API for Logitech Arx Control features.

Methods Reference

  • overwolf.logitech.arx.init()
  • overwolf.logitech.arx.publishApp()
  • overwolf.logitech.arx.addFileAs()
  • overwolf.logitech.arx.addContentAs()
  • overwolf.logitech.arx.addContentAs()
  • overwolf.logitech.arx.addUtf8StringAs()
  • overwolf.logitech.arx.addImageFromBitmap()
  • overwolf.logitech.arx.setIndex()
  • overwolf.logitech.arx.setTagPropertyById()
  • overwolf.logitech.arx.setTagsPropertyByClass()
  • overwolf.logitech.arx.setTagContentById()
  • overwolf.logitech.arx.setTagsContentByClass()
  • overwolf.logitech.arx.shutdown()

Events Reference

  • overwolf.logitech.arx.onEvent
  • overwolf.logitech.arx.onError

Types Reference

  • Logitech.Arx.Event.Data Object.

init(identifier, friendlyName, callback)

Version added: 0.93

Initializes the Arx API.

ParameterTypeDescription
identifierstringID for the app that will be discovered by LGS
friendlyNamestringFriendly display name
callbackfunctionCallback with the result of the request

publishApp(indexFilename, callback)

Version added: 0.93

Publishes an entire app according to the folder set in the manifest file and/or optional sets in an index file.

ParameterTypeDescription
indexFilenamestringOptional file to use as index
callbackfunctionCallback with the result of the request

addFileAs(fileUrl, fileName, mimeType, callback)

Version added: 0.93

Adds a file using an overwolf-extension:// or overwolf-media:// url.

ParameterTypeDescription
fileUrlstringOverwolf url to add
fileNamestringFile name to add as
mimeTypestringOptional mime type
callbackfunctionCallback with the result of the request

addContentAs(base64Content, fileName, callback)

Version added: 0.93

Adds content from a base64 string.

ParameterTypeDescription
base64ContentstringBase64 string
fileNamestringFile name to add as
callbackfunctionCallback with the result of the request

addContentAs(content, fileName, mimeType, callback)

Version added: 0.93

Adds content from a byte array.

ParameterTypeDescription
contentByte[]Base64 string
fileNamestringFile name to add as
mimeTypestringOptional mime type
callbackfunctionCallback with the result of the request

addUtf8StringAs(stringContent, fileName, mimeType, callback)

Version added: 0.93

Adds content from a UTF8 string.

ParameterTypeDescription
stringContentstringUTF8 string
fileNamestringFile name to add as
mimeTypestringOptional mime type
callbackfunctionCallback with the result of the request

addImageFromBitmap(bitmap, width, height, fileName, callback)

Version added: 0.93

Add an image from a bitmap.

ParameterTypeDescription
bitmapByte[]A byte array representing a bitmap
widthintWidth of the bitmap
heightintHeight of the bitmap
fileNamestringFile name to add as
callbackfunctionCallback with the result of the request

setIndex(fileName, callback)

Version added: 0.93

Sets the index file of the website.

ParameterTypeDescription
fileNamestringFile to use as index
callbackfunctionCallback with the result of the request

setTagPropertyById(tagId, prop, newValue, callback)

Version added: 0.93

Sets a property of a tag by ID.

ParameterTypeDescription
tagIdstringID of the tag to set the property to
propstringName of the property to change
newValuestringNew value
fileNamestringFile name to add as
callbackfunctionCallback with the result of the request

setTagsPropertyByClass(tagsClass, prop, newValue, callback)

Version added: 0.93

Sets a property of a tag by class.

ParameterTypeDescription
tagsClassstringClass of the tag(s) to set the property to
propstringName of the property to change
newValuestringNew value
callbackfunctionCallback with the result of the request

setTagContentById(tagId, newContent, callback)

Version added: 0.93

Sets the content of a tag by ID.

ParameterTypeDescription
tagIdstringID of the tag to set the content to
newContentstringNew content
callbackfunctionCallback with the result of the request

setTagsContentByClass(tagsClass, newContent, callback)

Version added: 0.93

Sets the content of a tag by ID.

ParameterTypeDescription
tagsClassstringClass of the tag(s) to set the content to
newContentstringNew content
callbackfunctionCallback with the result of the request

shutdown()

Version added: 0.93

Shuts down the API.

onEvent

Version added: 0.93

An Arx event sent with a [Logitech.Arx.Event.Data] object.

onError

Version added: 0.93

Triggered when an error occurs, sent with an error code.

Logitech.Arx.Event.Data Object

Version added: 0.93

Describes an Arx event.

ParameterTypeDescription
eventTypeintType code of the event
eventTypeStringstringType name of the event
eventValueintValue code of the event
eventValueStringstringValue string on the event
eventArgstringArgument of the event
contextIntPtrContext of the event
Last updated on 2019-9-17 by Shoomanjin
← overwolf.logitechoverwolf.logitech.led →
  • Methods Reference
  • Events Reference
  • Types Reference
  • init(identifier, friendlyName, callback)
  • publishApp(indexFilename, callback)
  • addFileAs(fileUrl, fileName, mimeType, callback)
  • addContentAs(base64Content, fileName, callback)
  • addContentAs(content, fileName, mimeType, callback)
  • addUtf8StringAs(stringContent, fileName, mimeType, callback)
  • addImageFromBitmap(bitmap, width, height, fileName, callback)
  • setIndex(fileName, callback)
  • setTagPropertyById(tagId, prop, newValue, callback)
  • setTagsPropertyByClass(tagsClass, prop, newValue, callback)
  • setTagContentById(tagId, newContent, callback)
  • setTagsContentByClass(tagsClass, newContent, callback)
  • shutdown()
  • onEvent
  • onError
  • Logitech.Arx.Event.Data Object
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf