Skip to content

Fix plugin arguments docs / man page / help text #5838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2024

Conversation

bastimeyer
Copy link
Member

@bastimeyer
Copy link
Member Author

bastimeyer commented Feb 17, 2024

1 and 2:
twitch arguments from the --help output with plugins data from JSON. Correct order and no suppressed arguments.

  Twitch:
    --twitch-disable-ads
    Skip embedded advertisement segments at the beginning or during a stream.
    Will cause these segments to be missing from the output.
    
    --twitch-low-latency
    Enables low latency streaming by prefetching HLS segments.
    Sets --hls-segment-stream-data to true and --hls-live-edge to 2, if it is higher.
    Reducing --hls-live-edge to `1` will result in the lowest latency possible, but will most likely cause buffering.
    
    In order to achieve true low latency streaming during playback, the player's caching/buffering settings will
    need to be adjusted and reduced to a value as low as possible, but still high enough to not cause any buffering.
    This depends on the stream's bitrate and the quality of the connection to Twitch's servers. Please refer to the
    player's own documentation for the required configuration. Player parameters can be set via --player-args.
    
    Note: Low latency streams have to be enabled by the broadcasters on Twitch themselves.
    Regular streams can cause buffering issues with this option enabled due to the reduced --hls-live-edge value.
    
    --twitch-api-header KEY=VALUE
    A header to add to each Twitch API HTTP request.
    
    Can be repeated to add multiple headers.
    
    Useful for adding authentication data that can prevent ads. See the plugin-specific documentation for more information.
    
    --twitch-access-token-param KEY=VALUE
    A parameter to add to the API request for acquiring the streaming access token.
    
    Can be repeated to add multiple parameters.
    
    --twitch-purge-client-integrity
    Purge cached Twitch client-integrity token and acquire a new one.

3:
sbscokr is not listed anymore in the CLI docs or man page (only suppressed plugin arguments):

@bastimeyer bastimeyer changed the title options: fix object identity of argparse.SUPPRESS Fix plugin arguments docs / man page / help text Feb 17, 2024
@bastimeyer bastimeyer merged commit f39eb13 into streamlink:master Feb 17, 2024
@bastimeyer bastimeyer deleted the fix-plugin-arguments-docs branch February 17, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants