Class VideoFlags


  • public final class VideoFlags
    extends Object
    Video flags contain information about the available video actions and its dynamic properties based on the current video state.
    • Constructor Summary

      Constructors 
      Constructor Description
      VideoFlags()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canStream()
      Get the canStream property: Value indicating whether or not the video can be streamed.
      boolean hasData()
      Get the hasData property: Value indicating whether or not there has ever been data recorded or uploaded into the video.
      boolean isInUse()
      Get the isInUse property: Value indicating whether or not the video is currently being referenced be an active pipeline.
      void validate()
      Validates the instance.
      VideoFlags withCanStream​(boolean canStream)
      Set the canStream property: Value indicating whether or not the video can be streamed.
      VideoFlags withHasData​(boolean hasData)
      Set the hasData property: Value indicating whether or not there has ever been data recorded or uploaded into the video.
      VideoFlags withIsInUse​(boolean isInUse)
      Set the isInUse property: Value indicating whether or not the video is currently being referenced be an active pipeline.
    • Constructor Detail

      • VideoFlags

        public VideoFlags()
    • Method Detail

      • canStream

        public boolean canStream()
        Get the canStream property: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
        Returns:
        the canStream value.
      • withCanStream

        public VideoFlags withCanStream​(boolean canStream)
        Set the canStream property: Value indicating whether or not the video can be streamed. Only "archive" type videos can be streamed.
        Parameters:
        canStream - the canStream value to set.
        Returns:
        the VideoFlags object itself.
      • hasData

        public boolean hasData()
        Get the hasData property: Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
        Returns:
        the hasData value.
      • withHasData

        public VideoFlags withHasData​(boolean hasData)
        Set the hasData property: Value indicating whether or not there has ever been data recorded or uploaded into the video. Newly created videos have this value set to false.
        Parameters:
        hasData - the hasData value to set.
        Returns:
        the VideoFlags object itself.
      • isInUse

        public boolean isInUse()
        Get the isInUse property: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
        Returns:
        the isInUse value.
      • withIsInUse

        public VideoFlags withIsInUse​(boolean isInUse)
        Set the isInUse property: Value indicating whether or not the video is currently being referenced be an active pipeline. The fact that is being referenced, doesn't necessarily indicate that data is being received. For example, video recording may be gated on events or camera may not be accessible at the time.
        Parameters:
        isInUse - the isInUse value to set.
        Returns:
        the VideoFlags object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.