JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::InputSource Class Referenceabstract

A lightweight object that can create a stream to read some kind of resource. More...

#include <juce_InputSource.h>

Inheritance diagram for juce::InputSource:

Public Member Functions

 InputSource () noexcept
 
virtual ~InputSource ()
 Destructor. More...
 
virtual InputStreamcreateInputStream ()=0
 Returns a new InputStream to read this item. More...
 
virtual InputStreamcreateInputStreamFor (const String &relatedItemPath)=0
 Returns a new InputStream to read an item, relative. More...
 
virtual int64 hashCode () const =0
 Returns a hash code that uniquely represents this item. More...
 

Detailed Description

A lightweight object that can create a stream to read some kind of resource.

This may be used to refer to a file, or some other kind of source, allowing a caller to create an input stream that can read from it when required.

See also
FileInputSource

{Core}

Constructor & Destructor Documentation

◆ InputSource()

juce::InputSource::InputSource ( )
inlinenoexcept

◆ ~InputSource()

virtual juce::InputSource::~InputSource ( )
inlinevirtual

Destructor.

References JUCE_LEAK_DETECTOR.

Member Function Documentation

◆ createInputStream()

virtual InputStream* juce::InputSource::createInputStream ( )
pure virtual

Returns a new InputStream to read this item.

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

Implemented in juce::URLInputSource, and juce::FileInputSource.

◆ createInputStreamFor()

virtual InputStream* juce::InputSource::createInputStreamFor ( const String relatedItemPath)
pure virtual

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.

Implemented in juce::URLInputSource, and juce::FileInputSource.

◆ hashCode()

virtual int64 juce::InputSource::hashCode ( ) const
pure virtual

Returns a hash code that uniquely represents this item.

Implemented in juce::URLInputSource, and juce::FileInputSource.


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