OpenShot Library | OpenShotAudio  0.2.1
juce::FileInputSource Class Reference

A type of InputSource that represents a normal file. More...

#include <juce_FileInputSource.h>

+ Inheritance diagram for juce::FileInputSource:

Public Member Functions

 FileInputSource (const File &file, bool useFileTimeInHashGeneration=false)
 Creates a FileInputSource for a file. More...
 
 ~FileInputSource () override
 Destructor. More...
 
InputStreamcreateInputStream () override
 Returns a new InputStream to read this item. More...
 
InputStreamcreateInputStreamFor (const String &relatedItemPath) override
 Returns a new InputStream to read an item, relative. More...
 
int64 hashCode () const override
 Returns a hash code that uniquely represents this item.
 
- Public Member Functions inherited from juce::InputSource
virtual ~InputSource ()=default
 Destructor. More...
 

Detailed Description

A type of InputSource that represents a normal file.

See also
InputSource

Definition at line 38 of file juce_FileInputSource.h.

Constructor & Destructor Documentation

◆ FileInputSource()

juce::FileInputSource::FileInputSource ( const File file,
bool  useFileTimeInHashGeneration = false 
)

Creates a FileInputSource for a file.

If the useFileTimeInHashGeneration parameter is true, then this object's hashCode() method will incorporate the file time into its hash code; if false, only the file name will be used for the hash.

Definition at line 26 of file juce_FileInputSource.cpp.

◆ ~FileInputSource()

juce::FileInputSource::~FileInputSource ( )
override

Destructor.

Definition at line 31 of file juce_FileInputSource.cpp.

Member Function Documentation

◆ createInputStream()

InputStream * juce::FileInputSource::createInputStream ( )
overridevirtual

Returns a new InputStream to read this item.

Returns
an inputstream that the caller will delete, or nullptr if the filename isn't found.

Implements juce::InputSource.

Definition at line 35 of file juce_FileInputSource.cpp.

References juce::File::createInputStream().

◆ createInputStreamFor()

InputStream * juce::FileInputSource::createInputStreamFor ( const String relatedItemPath)
overridevirtual

Returns a new InputStream to read an item, relative.

Parameters
relatedItemPaththe relative pathname of the resource that is required
Returns
an inputstream that the caller will delete, or nullptr if the item isn't found.

Implements juce::InputSource.

Definition at line 40 of file juce_FileInputSource.cpp.

References juce::File::createInputStream(), and juce::File::getSiblingFile().


The documentation for this class was generated from the following files: