ISXTwitch:twitch (Object Type)

From ismods.com: dedicated to promoting white hat, EULA-compliant Inner Space and LavishScript mods
Jump to: navigation, search

The twitch Object Type manages the main streaming options for ISXTwitch.

Members

  • uint TargetFPS: Target framerate for the video stream
  • uint CPUUsage: 0 = low, 1 = medium, 2 = high
  • uint MaxKbps:
  • bool AdaptiveBitrate:
  • bool IncludeAudio:
  • bool IncludeMicrophone:
  • bool IsStreaming,
  • bool IsMicrophoneMuted:
  • float MicrophoneVolume:
  • float PlaybackVolume:
  • uint OutputWidth:
  • uint OutputHeight:
  • string Username: Active Twitch username
  • bool IsReady:
  • bool IsPaused:
  • bool IsChatOnly:
  • string ChannelName:
  • string ChannelDisplayName:
  • string ChannelURL:
  • string StreamState: State of the video stream; one of Uninitialized, LoggingIn, LoggedIn, FindingIngestServer, FoundIngestServer, ReadyToStream, Streaming, Stopping, Paused
  • twitchwebcamdevice SelectedWebcam:
  • string CurrentSceneName: Name of the currently active Scene. If a custom scene is not set, this will be "default"
  • twitchscene CurrentScene: Returns a twitchscene-derived type, either twitchdefaultscene or twitchcustomscene, for the currently active Scene
  • twitchdefaultscene DefaultScene:
  • twitchscene Scene[SCENE NAME]: Returns a twitchscene-derived type, either twitchdefaultscene or twitchcustomscene, for the Scene with the given name
  • twitchscene Scene[#]: Returns a twitchscene-derived type, either twitchdefaultscene or twitchcustomscene, for the Scene at the given index number (1-based)
  • uint NumScenes:
  • string Version:
  • string TwitchSDKVersion:

Methods

  • SetResolution[#x#]:
  • SetTargetFPS[#]:
  • SetCPUUsage[#]:
  • SetMaxKbps[#]:
  • SetAdaptiveBitrate[bool]:
  • SetIncludeAudio[bool]:
  • SetIncludeMicrophone[bool]:
  • SetMicrophoneMute[bool]:
  • SetMicrophoneStartMuted[bool]:
  • SetPushToTalk[NAME OF KEY]:
  • SetPushToTalk[-vkey,#]:
  • SetMicrophoneVolume[float]:
  • SetPlaybackVolume[float]:
  • Pause:
  • UnPause:
  • Stop:
  • Start:
  • RunCommercial:
  • SetChatOnly[bool]:
  • Initialize[TWITCH USERNAME,TWITCH PASSWORD]:
  • LoadFont[NAME,FILENAME]:
  • LoadFont[NAME,FILENAME,CHARACTER MAP FILENAME]:
  • LoadAnimation[NAME,XML FILENAME]:
  • UnloadAnimation[NAME]:
  • LoadScene[NAME,XML FILENAME]: Load a Scene from an XML settings file (e.g. created by ISXTwitchSceneEditor)
  • SetScene[NAME]: Set the current Scene

To Text

Returns "ISXTwitch"