docs: Document the aliasing situation with `VideoSource::Swf`

This commit is contained in:
David Wendt 2023-07-01 13:21:20 -04:00 committed by Adrian Wielgosik
parent d382b29fb1
commit 679f179a60
1 changed files with 7 additions and 0 deletions

View File

@ -96,6 +96,13 @@ pub enum VideoStream {
#[collect(no_drop)]
pub enum VideoSource<'gc> {
/// A video bitstream embedded inside of a SWF movie.
///
/// NOTE: Fields within this enum will be shared across all instances of a
/// particular character. If you need to mutate the video source, consider
/// reallocating a new source for your specific video instead.
///
/// This warning does not apply to `NetStream` or `Unconnected` videos,
/// which are never aliased.
Swf {
/// The video stream definition.
#[collect(require_static)]