Skip to main content

overwolf.social.youtube API

Provides access to the YouTube social provider.

tip

You can use verwolf.social.getDisabledServices() method to check if the service is available.

Methods Reference​

Events Reference​

Types Reference​

performUserLogin()​

Version added: 0.128​

Opens the login dialog.

There is no callback for this method and the only way to know if the user signed in is via onLoginStateChanged event.

performLogout(callback)​

Version added: 0.125​

Performs a "strong" sign out of YouTube, so that even if the user performs a login via the Overwolf Settings / Accounts page, he will be considered signed out.

ParameterTypeDescription
callback(Result) => voidA callback function which will be called with the status of the request

getUserInfo(callback)​

Version added: 0.125​

If the user is currently logged into YouTube, this will return user information, Otherwise, an error is returned.

ParameterTypeDescription
callback(Result: GetUserInfoResult) => voidA callback function which will be called with the status of the request

share(YouTubeShareParameters, callback)​

Version added: 0.125​

If the user is currently logged into YouTube, this will perform the video share.

ParameterTypeDescription
youTubeShareParamsYouTubeShareParameters ObjectThe share parameters
callback(Result) => voidA callback function which will be called with the status of the request

Types of errors that can occur:

  • Disconnected (user isn't signed in)
  • MissingFile (trying to share a missing file)
  • UnsupportedFile (trying to share an unsupported format)
  • Forbidden (user did not give Overwolf permissions to upload videos)
  • NoChannelsFound (user does not have a youtube channel associated with this Google account)

shareEx(YouTubeShareParameters, callback, callback)​

Version added: 0.198​

If the user is currently logged into Youtube, this will perform the video share.

ParameterTypeDescription
youtubeShareParamsYoutubeShareParameters ObjectThe share parameters
resultCallback(SocialShareResult) => voidA callback function which will be called with the resulting status of the request
progressCallback(socialShareProgress) => voidA callback function which will be called whenever share progress is made. See note

Types of errors that can occur:

  • Disconnected (user isn't signed in)
  • MissingFile (trying to share a missing file)
  • UnsupportedFile (trying to share an unsupported format)
  • Forbidden (user did not give Overwolf permissions to upload videos)
  • NoChannelsFound (user does not have a youtube channel associated with this Google account)

Progress Note​

This callback will only be called when uploading a video.

Videos will be uploaded in uniforamlly sized chunks (except for the last chunk). The callback will be called every time another chunk was successfully uploaded.

cancelShare(string, callback)​

Version added: 0.198​

cancels an ongoing share request with the given id, if valid. Callback will be invoked with success if such a request was found and a cancellation order was executed (may take a while)

ParameterTypeDescription
idstringThe request ID
callback(Result) => voidCalled with the result of the cancellation
overwolf.social.youtube.cancelShare("2", console.log)

onLoginStateChanged​

Version added: 0.125​

Fired when the user’s login state changes, with the following structure: LoginStateChangedEvent Object.

YouTubeShareParameters Object​

Version added: 0.125​

This object defines all parameters that can/should be passed to the Youtube share() and shareEx() methods.

ParameterTypeDescription
filestringThe file to share
id (Optional)stringThe ID for the current share request. See note
useOverwolfNotificationsbooleanWhether or not Overwolf notifications should be used. See note
titlestringThe shared video's title
descriptionstringThe shared video's description
trimming (Optional)VideoCompositionSegmentAn object containing start time and end time for the desired VideoCompositionSegment
privacyYouTubePrivacyThe privacy policy of the uploaded video, defaults to public
tags (Optional)stringAn array of chronological events that occurred during the capture
gameClassId (Optional)intThe associated game's class ID
gameTitle (Optional)stringThe associated game's title
metadata (Optional)ObjectExtra information about the game session

id note​

When calling overwolf.social.youtube.shareEx(), it is required to supply it with a request ID. This ID will also be used in case you wish to cancel this share using overwolf.social.youtube.cancelShare().

useOverwolfNotifications note​

When calling overwolf.social.youtube.share(), this will default to true. When calling overwolf.social.youtube.shareEx(), this will default to false.

SocialShareResult Object​

Version added: 0.198​

Container for the url shared in a successful share.

ParameterTypeDescription
urlstringThe url of the generated result

Example data​

{
  "url": "https://www.youtube.com/watch?v=iik25wq1251"
}

SocialShareProgress Object​

Version added: 0.198​

The current progress of the share request

ParameterTypeDescription
progressintThe current precentage of upload progress
idstringThe id of the share request
stateShareStateThe current state of the share request

Example data​

{
  "progress": 99,
  "id": "7",
  "state": "Uploading"
}

ShareState Enum​

Version added: 0.198​

The current state of the overwolf.social.youtube.shareEx() operation.

OptionsDescription
StartedThe upload has started
UploadingThe upload is in progress
FinishedThe upload has finished

YouTubePrivacy Enum​

version added: 0.198​

The listing status of the uplaoded video.

OptionDescription
PublicThe video will be public
UnlistedThe video will be unlisted
PrivateThe video will be private
idstring
statestring