ObsHelperCommand class abstract

Inheritance

• Object
• Command
• ObsHelperCommand

Implementers

• ObsBroadcastCustomEventCommand
• ObsBrowserEventCommand
• ObsCallVendorRequestCommand
• ObsGetCurrentProgramSceneCommand
• ObsGetGroupListCommand
• ObsGetHotkeyListCommand
• ObsGetInputKindListCommand
• ObsGetInputListCommand
• ObsGetInputMuteCommand
• ObsGetMonitorListCommand
• ObsGetRecordDirectoryCommand
• ObsGetSceneItemListCommand
• ObsGetSceneItemLockedCommand
• ObsGetScenesListCommand
• ObsGetSourceActiveCommand
• ObsGetSourceScreenshotCommand
• ObsGetStatsCommand
• ObsGetStreamServiceSettingsCommand
• ObsGetStreamStatusCommand
• ObsGetStudioModeEnabledCommand
• ObsGetVersionCommand
• ObsGetVideoSettingsCommand
• ObSleepCommand
• ObsListenCommand
• ObsRemoveInputCommand
• ObsSaveSourceScreenshotCommand
• ObsSendCommand
• ObsSendStreamCaptionCommand
• ObsSetInputMuteCommand
• ObsSetInputNameCommand
• ObsSetSceneItemLockedCommand
• ObsSetStreamServiceSettingsCommand
• ObsSetStudioModeEnabledCommand
• ObsSetVideoSettingsCommand
• ObsStartStreamCommand
• ObsStopStreamCommand
• ObsToggleInputMuteCommand
• ObsToggleStreamCommand
• ObsTriggerHotkeyByKeySequenceCommand
• ObsTriggerHotkeyByNameCommand

Constructors

ObsHelperCommand()

Properties

aliases → List<String>

Alternate names for this command.

no setter, inherited

argParser → ArgParser

The argument parser for this command.

no setter, inherited

argResults → ArgResults?

The parsed argument results for this command.

no setter, inherited

category → String

The command's category.

no setter, inherited

description → String

A description of this command, included in usage.

no setter, inherited

globalResults → ArgResults?

The parsed global argument results.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hidden → bool

Whether or not this command should be hidden from help listings.

no setter, inherited

invocation → String

A single-line template for how to invoke this command (e.g. "pub get package").

no setter, inherited

name → String

The name of this command.

no setter, inherited

obs → ObsWebSocket

no setter

parent → Command?

The command's parent command, if this is a subcommand.

no setter, inherited

runner → CommandRunner?

The command runner for this command.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

subcommands → Map<String, Command>

An unmodifiable view of all sublevel commands of this command.

no setter, inherited

suggestionAliases → List<String>

Alternate non-functional names for this command.

no setter, inherited

summary → String

A short description of this command, included in parent's CommandRunner.usage.

no setter, inherited

takesArguments → bool

Whether or not this command takes positional arguments in addition to options.

no setter, inherited

usage → String

Generates a string displaying usage information for this command.

no setter, inherited

usageFooter → String?

An optional footer for usage.

no setter, inherited

Methods

addSubcommand(Command command) → void

Adds Command as a subcommand of this.

inherited

initializeObs() → Future<void>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

printUsage() → void

Prints the usage information for this command.

inherited

run() → FutureOr?

Runs this command.

inherited

toString() → String

A string representation of this object.

inherited

usageException(String message) → Never

Throws a UsageException with message.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited