chore: update MediaElement docs to include custom http headers feature#639
chore: update MediaElement docs to include custom http headers feature#639Kaaybi wants to merge 2 commits intoMicrosoftDocs:mainfrom
Conversation
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 493e3c0: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@microsoft-github-policy-service agree |
There was a problem hiding this comment.
Pull request overview
Updates the .NET MAUI Community Toolkit MediaElement documentation to describe the new capability to send custom HTTP headers when playing remote media.
Changes:
- Added a new “Play remote media with custom HTTP headers” scenario section, including code samples.
- Documented the
MediaSource.FromUri(Uri, IDictionary<string, string>)overload for passing HTTP headers. - Expanded
UriMediaSourcedescription to mention theHttpHeadersproperty and its behavior.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jfversluis
left a comment
jfversluis
left a comment
There was a problem hiding this comment.
See comments, please double-check if this is all in order, exists and make sure the code is clear. Ideally ready to copy and paste for as much as possible.
The note about iOS and macOS is not super clear to me as AVURLAssetHTTPHeaderFieldsKey is never mentioned but I do need to watch out for it...?
|
Learn Build status updates of commit 43391ee: ✅ Validation status: passed
For more details, please refer to the build report. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Hi Gerald, thanks for reading through 🙏
Fixed!
It was indeed ambiguous, I rephrased the sentence, is it clear enough now? |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `FromFile`, returns a `FileMediaSource` instance from a `string` argument. | ||
| - `FromUri`, returns a `UriMediaSource` instance from a `Uri` argument. | ||
| - `FromUri(Uri, IDictionary<string, string>)`, returns a `UriMediaSource` instance from a `Uri` argument with custom HTTP headers applied to all requests. | ||
| - `FromResource`, returns a `ResourceMediaSource` instance from a `string` argument. |
There was a problem hiding this comment.
The MediaSource static-method list mixes a bare method name (FromUri) with a full signature for the overload (FromUri(Uri, IDictionary<string, string>)). To keep the docs consistent/clear, consider listing both overloads with signatures (e.g., FromUri(Uri) and FromUri(Uri, IDictionary<string,string>)), or list only method names and note that FromUri has an overload accepting headers.
| - `FromFile`, returns a `FileMediaSource` instance from a `string` argument. | |
| - `FromUri`, returns a `UriMediaSource` instance from a `Uri` argument. | |
| - `FromUri(Uri, IDictionary<string, string>)`, returns a `UriMediaSource` instance from a `Uri` argument with custom HTTP headers applied to all requests. | |
| - `FromResource`, returns a `ResourceMediaSource` instance from a `string` argument. | |
| - `FromFile(string)`, returns a `FileMediaSource` instance from a `string` argument. | |
| - `FromUri(Uri)`, returns a `UriMediaSource` instance from a `Uri` argument. | |
| - `FromUri(Uri, IDictionary<string, string>)`, returns a `UriMediaSource` instance from a `Uri` argument with custom HTTP headers applied to all requests. | |
| - `FromResource(string)`, returns a `ResourceMediaSource` instance from a `string` argument. |
|
Converting to draft until the actual feature is merged, otherwise looks good to me! |
Adds documentation on MediaElement new feature custom http headers