MovieLoader Manual

Table of Contents

• About
• Allocation/Deallocation
• Functionality
• Further Reading

About

The MovieLoader class is used to load image data from a movie file.

Warning

For Maxon API media input and output see Media Sessions Manual.

Allocation/Deallocation

A MovieLoader can be created with the usual tools:

• MovieLoader::Alloc(): Creates a new MovieLoader object.
• MovieLoader::Free(): Deletes the given MovieLoader object.

Functionality

A MovieLoader object simply opens a movie file to read its content:

• MovieLoader::Open(): Opens the given movie file.
• MovieLoader::GetInfo(): Gets the movie's frame rate and frame count.
• MovieLoader::Read(): Returns the frame with the given index as a BaseBitmap.
• MovieLoader::Close(): Closes the currently open movie file.

Note

See also GeGetMovieInfo().

  // This example loads the given movie file and displays
  // each frame of the movie in the Picture Viewer.
 
  AutoAlloc<MovieLoader> movieLoader;
  if (movieLoader == nullptr)
    return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
 
  // load movie file
  const IMAGERESULT res = movieLoader->Open(selectedMovieFile);
  if (res != IMAGERESULT::OK)
    return maxon::IoError(MAXON_SOURCE_LOCATION, MaxonConvert(selectedMovieFile, MAXONCONVERTMODE::NONE), "Could not open movie file."_s);
 
  // get movie info
  Float       fps = 0.0;
  const Int32 frames = movieLoader->GetInfo(&fps);
 
  // load and display each frame
  for (Int32 i = 0; i < frames; ++i)
  {
    // load frame
    Int32 frameResult;
    BaseBitmap* const frameContent = movieLoader->Read(i, &frameResult);
 
    // check if frame could been loaded
 
    const Int32 imageOK = Int32(IMAGERESULT::OK);
    if (frameResult != imageOK)
      return maxon::UnknownError(MAXON_SOURCE_LOCATION);
 
    if (frameContent == nullptr)
      return maxon::UnknownError(MAXON_SOURCE_LOCATION);
 
    // show frame
    ShowBitmap(frameContent);
  }
  movieLoader->Close();

Further Reading

• Files & Media
• Cinema API Files & Media
• BaseBitmap Manual
• MovieSaver Manual