StaticSource Class

Inheritance diagram of StaticSource

class StaticSource(source)

A source that has been completely decoded in memory. This source can be queued onto multiple players any number of times.

Constructor:

__init__(source)

Construct a StaticSource for the data in source.

Parameters:source (Source) – The source to read and decode audio and video data from.

Methods:

get_animation() Import all video frames into memory as an Animation.
get_audio_data(bytes)
get_next_video_frame() Get the next video frame.
get_next_video_timestamp() Get the timestamp of the next video frame.
play() Play the source.
seek(timestamp) Seek to given timestamp.

Attributes:

audio_format
duration The length of the source, in seconds.
info
video_format

Methods

StaticSource.get_audio_data(bytes)

Inherited members

Methods

StaticSource.get_animation()

Import all video frames into memory as an Animation.

An empty animation will be returned if the source has no video. Otherwise, the animation will contain all unplayed video frames (the entire source, if it has not been queued on a player). After creating the animation, the source will be at EOS.

This method is unsuitable for videos running longer than a few seconds.

Note

Since pyglet 1.1

Return type:pyglet.image.Animation
StaticSource.get_next_video_frame()

Get the next video frame.

Video frames may share memory: the previous frame may be invalidated or corrupted when this method is called unless the application has made a copy of it.

Note

Since pyglet 1.1

Return type:pyglet.image.AbstractImage
Returns:The next video frame image, or None if the video frame could not be decoded or there are no more video frames.
StaticSource.get_next_video_timestamp()

Get the timestamp of the next video frame.

Note

Since pyglet 1.1

Return type:float
Returns:The next timestamp, or None if there are no more video frames.
StaticSource.play()

Play the source.

This is a convenience method which creates a ManagedSoundPlayer for this source and plays it immediately.

Return type:ManagedSoundPlayer
StaticSource.seek(timestamp)

Seek to given timestamp.

Attributes

StaticSource.audio_format = None
StaticSource.duration

The length of the source, in seconds.

Not all source durations can be determined; in this case the value is None.

Read-only.

Type:float
StaticSource.info = None
StaticSource.video_format = None

Table Of Contents

Previous topic

StaticMemorySource Class

Next topic

StreamingSource Class