Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

Commit

Permalink
Merge branch 'feature/user_agent_doc' into minor
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanheise committed May 31, 2023
2 parents 4f07e35 + aea4ff1 commit b8edd0c
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions just_audio/lib/just_audio.dart
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,14 @@ class AudioPlayer {

/// Creates an [AudioPlayer].
///
/// If [userAgent] is specified, it will be included in the header of all HTTP
/// requests on Android, iOS and macOS to identify your agent to the server.
/// If set, just_audio will create a cleartext local HTTP proxy on your device
/// to forward HTTP requests with headers included. If [userAgent] is not
/// specified, this will default to Apple's Core Audio user agent on iOS/macOS
/// and to just_audio's own user agent on Android. On Web, the browser will
/// override any specified user-agent string with its own.
/// Apps requesting remote URLs should specify a `[userAgent]` string with
/// this constructor which will be included in the `user-agent` header on all
/// HTTP requests (except on web where the browser's user agent will be sent).
/// This header helps to identify to the server which app is submitting the
/// request. If unspecified, it will default to Apple's Core Audio user agent
/// on iOS/macOS, or just_audio's user agent on Android. Note: this feature
/// is implemented via a local HTTP proxy which requires non-HTTPS support to
/// be enabled. See the README page for setup instructions.
///
/// The player will automatically pause/duck and resume/unduck when audio
/// interruptions occur (e.g. a phone call) or when headphones are unplugged.
Expand Down

0 comments on commit b8edd0c

Please sign in to comment.